Webhooks

Update an existing webhook

patch/webhooks/{webhook_id}

Path parameters

webhook_idstring uuid required

The Webhook ID.

Request body

endpointstring

The URL where webhook events will be sent.

eventsstring[]

Array of event types to subscribe to.

status'enabled' | 'disabled'

The status of the webhook.

Example request

{
  "endpoint": "https://webhook.example.com/new-handler",
  "events": [
    "email.sent",
    "email.delivered"
  ],
  "status": "enabled"
}

Response

OK

objectstring

The type of object.

idstring uuid

The ID of the updated webhook.

Example response

{
  "object": "webhook",
  "id": "479e3145-dd38-476b-932c-529ceb705947"
}

Changes