Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

Workspace API key (full access). The workspace is derived from the key.

Body

application/json
url
string<uri>
required

HTTPS endpoint that receives deliveries.

Example:

"https://example.com/sentralbee/webhooks"

enabled_events
string[]
required

Event types to subscribe to, or ["*"] for all.

Example:
description
string
status
enum<string>
default:active
Available options:
active,
disabled

Response

Created endpoint (with one-time secret)

id
string<uuid>
url
string<uri>
description
string
enabled_events
string[]
status
enum<string>
Available options:
active,
disabled
last_delivery_at
string<date-time> | null
createdAt
string<date-time>
updatedAt
string<date-time>
secret
string

The signing secret — shown only once.

Example:

"whsec_…"