PATCH/webhooks/{webhook_id}

Update a webhook

Updates the endpoint URL, subscribed event types, or status of a webhook. Supply only the fields you want to change; status must be enabled or disabled, and events must contain at least one event type.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
webhook_idstringrequired
The UUID of the webhook to update.

Webhook fields to update; all fields are optional.

endpointstringoptional
The URL where webhook events will be sent.
eventsarray<string>optional
Array of event types to subscribe to.
statusstringoptional
The status of the webhook.
Allowed:enableddisabled

1 status code
200Returns the object type and identifier of the updated webhook.
objectstringoptional
The type of object.
idstringoptional
The ID of the updated webhook.

Error handling

The webhook_id path parameter must be a UUID that identifies an existing webhook. If provided, events must contain at least one item, and status must be enabled or disabled.