v25

OpenAPI 3.1.0raw.githubusercontent.com2026-08-015486519.4 KB
Webhooks

Update a builder webhook destination

Updates name, HTTPS URL, event types, or enabled state. URL changes force pending_verification and return a new verification token. A URL change returns 409 with error.reason=webhook_delivery_in_progress while this destination has an active delivery; retry the same mutation after that request completes.

patch/api/v1/webhooks/{id}

Path parameters

idinteger required

Webhook endpoint id owned by the authenticated API key user.

Headers

Idempotency-Keystring

Optional safe-retry key. Reuse the same value only when retrying the exact same mutation request body; a different body returns 422 and an in-flight matching request returns 409.

Request body

namestring
urlstring uri
event_typesWebhookEventType[]
enabledboolean

Response

Webhook destination

object'webhook' required