Configuring a Webhook
To configure a new webhook, use the Post method on the Webhooks API to create a new subscription.
Webhook Headers
When a webhook is delivered, there are header values are are passed with the webhook.
| Header Key | Description |
|---|---|
| x-webhook-messageid | Unique identifier for each message. |
| x-webhook-topic | The topic of the message |
| x-webhook-subtopic | The subtopic of the message |
| x-webhook-subscriptionid | The subscriptionId that caused the message to be generated. See (Get) |
| x-webhook-version | The version of the message. |
Retry Logic
A webhook will attempt to re-deliver upon receiving an error status code for 2 days.
If the webhook handler does not return a Successful Response, the Webhook will be retried. This can cause your webhook to be sent multiple times in a misconfigured endpoint.
The header key "x-webhook-messageid" can be used to detect multiple calls for the same message if needed.
Disable Logic
If an endpoint has not responded with a 2xx HTTP status code for multiple days in a row, the Webhook will be disabled