v25

OpenAPI 3.1.0raw.githubusercontent.com2026-08-014254240.1 KB

Webhook Subscriptions

Create webhook subscription

Creates a new webhook subscription.

post/v1/webhook_subscriptions

Headers

Idempotency-Keystring

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Request body

urlstring uri required

The HTTPS URL where webhook events will be delivered.

eventsstring[] required

Event types to subscribe to. Use ["*"] for all events.

Response

Success

idstring required

Unique identifier of the webhook subscription.

type'webhook_subscription' required

Resource type discriminator.

urlstring required

The HTTPS URL where webhook events are delivered.

eventsstring[] required

Event types this subscription receives.

created_atstring date-time required

ISO 8601 UTC timestamp when the subscription was created.

updated_atstring date-time required

ISO 8601 UTC timestamp when the subscription was last updated.