Skip to main content
PATCH
Update a webhook endpoint

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Body

application/json
url
string<uri>

URL where webhook payloads will be delivered. Must be HTTPS; a URL that resolves to a private or reserved address is rejected.

Maximum string length: 2048
Example:

"https://api.example.com/webhooks/conduit"

description
string

Human-readable description of this endpoint's purpose

Maximum string length: 255
Example:

"Production webhook receiver"

status
enum<string>

Set to disabled to pause deliveries without deleting the endpoint; set to active to resume.

Available options:
active,
disabled
subscription
object

Event subscription configuration

Example:

Response

id
string
required

Unique webhook endpoint identifier

Pattern: ^wep_[0-9A-Za-z]{22}$
url
string
required

URL where webhook payloads are delivered

Example:

"https://api.example.com/webhooks/conduit"

description
string | null
required

Human-readable description of this endpoint's purpose

Example:

"Production webhook receiver"

status
enum<string>
required

Whether this endpoint is currently receiving new deliveries. When disabled, the endpoint is excluded from event fan-out — no new deliveries are enqueued. In-flight (already-enqueued) deliveries are not cancelled and continue retrying per the normal schedule. Set back to active via PATCH to resume receiving new deliveries.

Available options:
active,
disabled
subscription
object
required

Event subscription configuration for this endpoint

createdAt
string<date-time>
required

ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"

updatedAt
string<date-time>
required

ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"