Sign in
Events & Batch Operations
events_and_batch

Create Webhook

Create a new webhook subscription.

post/api/v1/events/webhooks

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Headers

X-API-Keystring nullable

Request body

urlstring uri required

Webhook endpoint URL (must be HTTPS)

event_typesstring

CSV or '*' for all

resource_typesstring nullable

CSV of resource types

secretstring nullable

Secret for signing (auto-generated if not provided)

max_retriesinteger
retry_delay_secondsinteger
rate_limit_per_minuteinteger nullable
descriptionstring nullable
custom_headersobject nullable

Response

Successful Response

idstring required
organization_idstring required
urlstring required
event_typesstring required
resource_typesstring nullable required
activeboolean required
paused_atstring date-time nullable required
paused_reasonstring nullable required
max_retriesinteger required
retry_delay_secondsinteger required
rate_limit_per_minuteinteger nullable required
delivered_countinteger required
failed_countinteger required
last_delivery_atstring date-time nullable required
last_errorstring nullable required
descriptionstring nullable required
custom_headersobject nullable required
created_atstring date-time required
created_by_user_idstring nullable required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.