Webhooks
A webhook tells another tool that something happened in your Reigniter account. When the event happens, Reigniter sends a signed JSON message to the address you choose. That address can be an automation’s webhook trigger, another workflow tool, or your own server.
Events
Section titled “Events”| Event | Label in the app | Sent when |
|---|---|---|
video.completed |
Video completed | A video render finishes. The message carries a download link that works for 7 days. |
video.failed |
Video failed | A video render fails. |
training.completed |
Learner finished a module | A named learner reaches the end of a module, with their score and whether they passed. |
training.overdue |
Learner overdue | A learner has not finished by their due date. |
The full list is in Webhooks. Inside Automations you do not need a webhook: the Reigniter triggers (Video finished, Learner passed, and the rest) register themselves.
Add a webhook
Section titled “Add a webhook”-
Open Connectors > Webhooks.
-
Select Add.
-
Pick the event.
-
Paste the address that should receive it. It must be a public web address. Addresses on a private network are refused.
-
Select Add.
-
Copy the signing secret and store it somewhere safe. It is shown only once. Then select Done.
Check that it works
Section titled “Check that it works”Select the test button on the webhook to send a signed test message. Check that it arrives at your address.
Verify each message
Section titled “Verify each message”Every message is signed with your signing secret. Your receiving tool should check the signature before it trusts the message, so nobody else can send fake events to it. How to check the signature is covered in the API webhooks guide.
Each message also carries a delivery ID that stays the same when a delivery is retried. Use it to ignore duplicates.
Pause, resume or delete
Section titled “Pause, resume or delete”Each webhook in the list has buttons to:
- Pause it. It shows Paused and receives nothing until you Resume it.
- Delete it.
When deliveries fail
Section titled “When deliveries fail”- Reigniter retries a failed delivery a few times.
- The webhook shows how many deliveries in a row have failed, for example 3 failed. A successful delivery resets the count.
- After many failures in a row, the webhook is paused automatically. Fix the address, then resume it.
- A failed webhook never affects your renders.
Make videos from another tool
Section titled “Make videos from another tool”Webhooks send events out of Reigniter. To make videos from another tool, use an API key. See Build an automation or the API quickstart.