Sign in

v1

latestOpenAPI 3.0.42026-08-062942352.0 MB
Webhooks

Create a webhook

Creates a new webhook.

post/v3/webhooks

Request body

namestring required

Name of the webhook.

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