Create a webhook

Creates a new webhook.

POST/v3/webhooks
JWTwebhook:write

Request body

namestringrequired

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.

Length: [1,256]Pattern: ^(?!\s)(?!.*\s$)[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$

urlstringrequired

The endpoint which will receive the HTTP POST payload.

Length: [1,256]Format: uri

tokenstringrequired

The secret which will be used to sign the payload using HMAC256 algorithm.

Length: [1,256]

enabledbooleanrequired

Whether webhook is enabled, you can use it to disable a webhook.

eventsarray of stringrequired

The list of events which trigger the webhook.

Response

201 Created

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
urlstringrequired
tokenstringrequired
enabledbooleanrequired
statusstringrequired

Allowed values: healthy, unhealthy, suspended

eventsarray of stringrequired