v2

latestOpenAPI 3.1.02026-08-0858116535.1 KB

Webhooks

Update a Webhook

patch/v0/webhooks/{id}

idstring required

The id of the webhook

eventsEventType[]

The events to trigger the webhook

urlstring uri

The URL to send the webhook to

metadataobject

Set of key-value pairs you want to associate with this object.

Webhook

idstring required

The unique identifier for the webhook

object'webhook' required

status'active' | 'inactive' required

The status of the webhook

eventsEventType[] required

The events to trigger the webhook

urlstring uri required

The URL to send the webhook to

secretstring nullable required

The secret to verify the webhook signature. Only returned on Webhook creation.

metadataobject

The metadata of the webhook

createdAtstring date-time required

The date and time the webhook was created

updatedAtstring date-time required

The date and time the webhook was last updated