Skip to main content
POST
Create a new webhook

Body

application/json

Request body for creating a webhook.

url
string
required

Destination URL for webhook HTTP POST

Required string length: 1 - 2048
collection
string
required

Collection name to watch

Required string length: 1 - 100
events
string[]
required

Events to fire on: create, update, delete

Minimum array length: 1
secret
string | null

HMAC-SHA256 signing secret (auto-generated if omitted)

Maximum string length: 100
filter
string | null

Optional rule expression to conditionally fire webhook

enabled
boolean
default:true

Whether the webhook is active

headers
Headers · object | null

Optional custom HTTP headers to include in delivery

Response

Successful Response

Webhook creation response — includes secret (shown ONCE only).

id
string
required
account_id
string
required
url
string
required
collection
string
required
events
string[]
required
filter
string | null
required
enabled
boolean
required
headers
Headers · object | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
created_by
string | null
required
secret
string
required

Signing secret — save this, it will never be shown again