Skip to main content
PATCH
← Webhooks Change the URL, events, description or enabled. Omitted fields keep their value. Setting enabled: true also clears consecutive_failures and disabled_reason, so it is how you re-enable an endpoint Dcycle disabled.
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

Path Parameters

uuid
required
The endpoint id.Example: 5c9e2f14-8b7a-4d3e-9f60-1a2b3c4d5e6f

Body Parameters

string
New HTTPS URL. Same rules as on creation.
array[string]
Replaces the subscription. Available values: ingest_job.finished.
string | null
null clears it.
boolean
false stops deliveries; true re-enables and resets the failure count.

Response

The updated endpoint (200 OK):
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.

404 Not Found

The endpoint does not exist or belongs to another organization. Both cases return the same response.

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.

Get Webhook Endpoint

Read it back

Rotate Webhook Secret

Replace the secret