POST/webhooks

Create a webhook

Creates a webhook subscription that delivers selected event types to a specified endpoint. Provide an endpoint URL and at least one event type in events to configure the subscription.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

Webhook configuration containing the delivery endpoint and subscribed event types.

endpointstringrequired
The URL where webhook events will be sent.
eventsarray<string>required
Array of event types to subscribe to.

1 status code
201Returns the created webhook's object type, UUID, and signing secret for verifying webhook payloads.
objectstringoptional
The type of object.
idstringoptional
The ID of the webhook.
signing_secretstringoptional
The secret key used to verify webhook payloads.

Error handling

When you provide a request body, it must include endpoint and events. The events array must contain at least one event type.