v1

latestOpenAPI 3.0.42026-08-062942352.0 MB

Webhooks

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}

idstring required

Unique identifier for the webhook.

namestring nullable

Name of the webhook.

urlstring uri nullable

The endpoint which will receive the HTTP POST payload.

tokenstring nullable

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

enabledboolean nullable

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

eventsstring[] nullable

The list of events which trigger the webhook.

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