Documentation
Sign inGet started

Update a webhook endpoint

PATCH
/v1/webhooks/{webhook_id}
curl -X PATCH "https://us1.platform.bird.com/v1/webhooks/{webhook_id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
Updates one or more fields on the webhook endpoint. All fields are optional. Setting status to "active" re-enables a paused endpoint.
Verzoekpayload
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
id
string
verplicht
url
string
verplicht
description
string
events
array of string
verplicht
Concrete event types this endpoint is subscribed to.
status
string
verplicht
created_at
string
verplicht
updated_at
string
verplicht