Skip to main content
POST
Create webhook endpoint
Registers a new webhook endpoint for the authenticated tenant. The endpoint receives HTTP POST requests when matching events occur. The endpoint secret is returned once in the response — store it securely.
The number of webhook endpoints you can create depends on your billing plan. If you exceed your plan limit, the API returns 402 Payment Required.

Responses

The secret field is only returned in the creation response. Store it securely — you cannot retrieve it later. If you lose it, rotate the secret to generate a new one.

Authorizations

X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
name
string
required

Human-readable endpoint name

url
string
required

HTTPS URL for webhook deliveries

event_filters
string[]
required

Event types or wildcard patterns

Response

Endpoint created

id
string
name
string
url
string
status
string
secret
string
event_filters
string[]
created_at
string