Skip to main content
POST
Error

Authorizations

​
Authorization
string
header
required

API key authentication. Format: Bearer {key_id}:{secret}

Headers

​
Idempotency-Key
string

Idempotency key for safe retries (required for POST/PUT)

Body

application/json
​
url
string<uri>
required
​
events
string[]

Event types to subscribe to (empty = all)

Response

201 - application/json

Webhook endpoint created (includes secret)

​
id
string<uuid>
required
​
tenantId
string<uuid>
required
​
url
string<uri>
required
​
status
enum<string>
required
Available options:
ACTIVE,
DISABLED
​
createdAt
string<date-time>
required
​
events
string[]
​
secret
string

Only returned on creation