API reference · Schema
UpdateWebhookRequest
urlstringWhere events are POSTed: an https URL (plain http is accepted only by development deployments). Addresses that resolve to loopback, private, link-local or metadata networks are refused when delivering.
1–2048 characters
descriptionstringFree-text description
up to 500 characters
event_typesarray of stringEvent types to receive, or `["*"]` for every type (GET /v1/webhooks/event-types lists them). Organization events (billing) need `org_events: true`.
1–64 items
org_eventsbooleanAlso receive organization events (billing). Turning it on needs billing:read.
statusstring`paused` stops sending (pending deliveries are given up; redeliver them after resuming); `active` resumes and clears the failure streak.
One of
activepaused
Example
{
"status": "active"
}Used by
- Change a webhook destination, or pause or resume it
PATCH /v1/webhooks/{webhook_id}