Skip to main content
POST
Create Webhook

Headers

Authorization
string | null

Body

application/json

Request to create an outbound webhook subscription.

url
string
required
Required string length: 1 - 512
subscribed_events
string[]
required
Minimum array length: 1
description
string | null
Maximum string length: 500
secret
string | null
Required string length: 16 - 255

Response

Successful Response

Full webhook response.

id
string<uuid>
required
url
string
required
secret_prefix
string
required
subscribed_events
string[]
required
is_active
boolean
required
status
string
required
failure_count
integer
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
last_success_at
string<date-time> | null
last_failure_at
string<date-time> | null
description
string | null