Skip to main content
POST
← Webhooks Register an HTTPS URL that receives the organization’s events. The response is the only time the signing secret is returned.
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
string
required
Must be application/json

Body Parameters

string
required
HTTPS URL, up to 2,048 characters, that resolves to a public address. See URL requirements.Example: "https://erp.example.com/dcycle/webhooks"
array[string]
required
Events to receive, at least one. Available values: ingest_job.finished.
string | null
Up to 255 characters, to recognize the endpoint.
boolean
default:"true"
Create it disabled to set it up before it starts receiving.

Response

The endpoint and its secret (201 Created):
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.
string
Signing secret (whsec_…). Shown only in this response: store it to verify signatures.

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.

422 Unprocessable Entity

The body is invalid, in the standard validation format. The URL must use https, point to a public host and carry no credentials; event_types needs at least one subscribable event.

Send Test Event

Check it end to end

Webhooks

Events, signatures and retries