Skip to main content
POST
Create webhook

Authorizations

Authorization
string
header
required

Scoped API key created via POST /api/account/keys.

Body

application/json

Webhook parameters

url
string
required

Target HTTPS URL for webhook delivery

Example:

"https://example.com/webhook"

events
string[]

Event types to subscribe to (empty = all events)

headers
object[]

Custom HTTP headers to include with each delivery

hmacKey
string

Secret key for HMAC-SHA256 signature verification

Example:

"my-secret-key"

retries
object
session
string

Session name to filter events for (null = all sessions)

Response

Created

createdAt
string

When the webhook was registered

enabled
boolean

Whether this webhook is active

events
string[]

Subscribed event types (empty = all events)

headers
object[]

Custom HTTP headers included with each delivery

id
integer

Unique webhook identifier

retries
object
session
string

Session name to filter events for (null = all sessions)

tenantId
string

Tenant that owns this webhook

url
string

Target URL for webhook delivery