Events
A Webhook is triggered by one or multiple events you can subscribe to:
Secret
The secret can be used for security purpose. See the Security section for more informations.
Contact
The contact field is required on each new webhook subscription. It is used for alerting purpose in case we encounter any issue reaching your endpoint.
It must be a user registered to your company on the Dashboard.
Custom headers (optional)
Custom headers allow to send additional data through Webhooks.
While setting up your Webhook, you can provide some Key - Value data that will be forwarded to your endpoint.
Custom Headers are NOT meant to forward big data.
Webhook statuses
Each Webhook has a Status that describes its current state. Here are the different values:
| Status | Description |
|---|---|
| ENABLED | Webhook is active and ready to receive Notifications. |
| DISABLED | Webhook is inactive, notifications won't be sent. This value can be set from the Dashboard. |
| BROKEN | Webhook is broken, notifications won't be sent. Bodyguard's API has not been able to notify your endpoint after many retries. |
The BROKEN status is automatically set. To enabled the Webhook again, you will have to check and fix the issue. Then, go to your Dashboard and manually enable it.