Skip to main content
POST
Create endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string
required

https://…, publicly resolvable. Rejected otherwise.

description
string | null

Free-text label for humans reading the settings list.

event_types
string[] | null

Event types to receive. Omit or leave empty for ALL of them.

space_id
string | null

Raw uuid of the Space to scope deliveries to. Omit for org-wide (every Space).

Response

The endpoint, with its signing secret (shown once)

A freshly created endpoint. secret appears HERE and nowhere else, ever.

created_at
string
required
enabled
boolean
required
event_types
string[]
required

Empty = every event type.

failure_count
integer<int32>
required

Consecutive failed delivery attempts since the last success.

id
string
required

whe_<uuid>.

object
string
required

Discriminator for polymorphic SDK decoders. Always "webhook_endpoint".

updated_at
string
required
url
string
required
secret
string
required

The signing key, whsec_…. Store it now: it is not recoverable, and rotation means creating a new endpoint.

description
string | null
disabled_at
string | null
last_error
string | null

A clamped failure summary — a status code or transport class, never a response body.

last_success_at
string | null
space_id
string | null

null = org-wide.