Skip to main content
GET
← Webhooks The endpoints of the organization in x-organization-id, newest first. Secrets are never listed.
Beta. Part of the webhooks API, currently in beta. The contract may still change before general availability.

Request

Headers

string
required
API key of an organization admin.Example: sk_live_1234567890abcdef
string
required
The organization that owns the endpoints.Example: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Query Parameters

integer
default:"1"
Page number.
integer
default:"10"
Page size, 1 to 500.

Response

A page of endpoints (200 OK): items, total, page, size. Each item:
uuid
Endpoint id.
string
Where the events are sent.
string | null
Free text to recognize the endpoint.
array[string]
Subscribed events. Available values: ingest_job.finished.
boolean
Disabled endpoints receive nothing.
integer
Deliveries in a row that ended failed. At 5 the endpoint is disabled.
string | null
TOO_MANY_FAILURES when Dcycle disabled the endpoint; null otherwise.
datetime
UTC.
datetime
UTC.

Common Errors

401 Unauthorized

Missing or invalid API key.

403 Forbidden

ORG_ADMIN_REQUIRED: only organization admins can manage webhook endpoints. LOGGED_USER_NOT_MEMBER: the API key’s user is not a member of the organization.

Create Webhook Endpoint

Register a URL

Get Webhook Endpoint

One endpoint by id