Sign in
Webhooks

Create a builder webhook destination

Creates a pending HTTPS webhook destination. The response includes one-time signing_secret and verification.token values. Deliveries are not sent until the endpoint is verified.

post/api/v1/webhooks

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 required
urlstring uri required

Public HTTPS callback URL. Local/private/internal targets are rejected.

event_typesWebhookEventType[] required

Response

Webhook destination

object'webhook' required

Changes