Webhooks
Create a webhook
Creates a new webhook.
post/v3/webhooks
Request body
namestring required
Name of the webhook.
Any printable characters, including letters from any script, punctuation and emoji. Cannot contain line breaks, tabs, other control characters, invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.
urlstring uri required
The endpoint which will receive the HTTP POST payload.
tokenstring required
The secret which will be used to sign the payload using HMAC256 algorithm.
enabledboolean required
Whether webhook is enabled, you can use it to disable a webhook.
eventsstring[] required
The list of events which trigger the webhook.
Response
Created
idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
urlstring required
tokenstring required
enabledboolean required
status'healthy' | 'unhealthy' | 'suspended' required
eventsstring[] required