Rolfsvaag_Datateknikk/Lumi
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
Lumi/plugins/throne_wishlist/README.md
Franz Rolfsvaag 5588819df4 Add webhook framework and Throne wishlist plugin
2026-06-10 18:57:38 +02:00

2.6 KiB
Raw Permalink Blame History

Throne Wishlist

This plugin receives signed Throne wishlist events through Lumi's core webhook framework, logs every payload, deduplicates by event_id, and can publish messages to configured platform destinations.

Setup

  1. Install the core webhook framework patch.
  2. Install and enable this plugin.
  3. Open Plugins -> Throne Wishlist as an administrator.
  4. Create an endpoint with a short identifier.
  5. Copy the generated /webhooks/throne/{identifier}-{uuid} URL into Throne's webhook integration.

Throne requires an HTTPS subscriber URL in production. Configure Lumi behind an HTTPS reverse proxy and set public_base_url in Lumi settings when available.

Security and Delivery

Throne requests are verified with the Ed25519 public key published in Throne's current webhook documentation. Verification uses X-Signature-Timestamp + "." + the exact raw request body, with a five-minute replay window. Invalid signatures never trigger platform messages.

Authentic duplicate event_id values receive a successful response without repeating side effects. Supported events are gift_purchased, contribution_purchased, and gift_crowdfunded. Unknown authentic events are logged and acknowledged without sending messages.

Debug Mode

The admin Debug modal uses a transient Server-Sent Events session. It only shows payloads received after the session starts. Closing the modal or disconnecting ends the session. Sessions expire after five minutes without payloads and after 30 minutes total. Debug payloads are not stored separately; all webhook payloads are already written to Lumi's internal logs.

Destinations

  • Discord requires a regular guild text channel where the bot can view and send.
  • Twitch uses the first connected Lumi Twitch channel.
  • YouTube uses Lumi's active live-chat sender.
  • Kick remains unavailable until Lumi implements a send-message capability.

All destinations default to disabled. A failure on one destination does not prevent delivery attempts to other enabled destinations.

Placeholders

Common placeholders:

{contract_version}, {event_id}, {event_type}, {webhook_identifier}, {webhook_uuid}, {received_at}, {received_at_iso}, {creator_id}, {creator_username}, {gifter_username}, {message}, {item_name}, {item_thumbnail_url}, {price}, {amount}, {currency}, {is_surprise_gift}, {price_display}, {amount_display}, {value}, {value_display}, and {payload_json}.

Documented data fields are also available with a data. prefix, such as {data.item_name}. Unknown placeholders remain unchanged in rendered messages. The admin page warns when they are saved.