Update a webhook endpoint

PATCH

/v1/webhooks/{webhook_id}

Updates one or more fields on the webhook endpoint. All fields are optional. Setting status to "active" re-enables a paused endpoint.

Request Payload

url

string

New HTTPS URL to deliver events to.

description

string

Human-readable label for this endpoint.

events

array of string

Replacement set of event type subscriptions.

status

string

Set to "active" to re-enable a paused endpoint, or "paused" to stop delivery.

Response Payload

string

required

url

string

required

description

string

events

array of string

required

Concrete event types this endpoint is subscribed to.

status

string

required

created_at

string

required

updated_at

string

required

cURL

curl -X PATCH "https://us1.platform.bird.com/v1/webhooks/{webhook_id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'