API OverviewAPI EndpointsWebhooks

Create a webhook subscription

Create a new webhook subscription to receive real-time events

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringRequired
Entity ID to create subscription for

Request

This endpoint expects an object.
webhookUrlstringRequiredformat: "uri"
URL to receive webhook events
eventslist of enumsRequired
Array of event types to subscribe to
secretstringOptional

Secret for webhook signature verification (optional)

Response

Webhook subscription created successfully
successboolean or null
subscriptionobject or null

Errors