Update a webhook

Updates the specified webhook by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/webhooks/{id}
JWTwebhook:write

Path parameters

idstringrequired

Unique identifier for the webhook.

Request body

namestring

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}]+$

urlstring

The endpoint which will receive the HTTP POST payload.

Length: [1,256]Format: uri

tokenstring

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

Length: [1,256]

enabledboolean

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

eventsarray of string

The list of events which trigger the webhook.

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
urlstringrequired
tokenstringrequired
enabledbooleanrequired
statusstringrequired

Allowed values: healthy, unhealthy, suspended

eventsarray of stringrequired