Skip to main content
PATCH
Update a webhook endpoint

Authorizations

Authorization
string
header
required

Use Authorization: Bearer end_sk_* for partner API keys (e.g. end_sk_AbCd_example_api_key).

Path Parameters

endpoint_id
string<uuid>
required
Example:

"8e1a7f50-90ab-4cde-8012-3456789abcde"

Body

application/json
url
string<uri>

HTTPS URL on a public host.

Maximum string length: 2048
Example:

"https://hooks.example.com/endstate"

event_types
string[]
Required array length: 1 - 64 elements
Minimum string length: 1
Example:
description
string | null
Maximum string length: 512
api_version
string

Dated payload version; must be the current version or an older one the platform still renders.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-09-01"

status
enum<string>

Send disabled to stop deliveries to the endpoint, or enabled to resume them; recover then resends what was missed.

Available options:
enabled,
disabled

Response

The updated endpoint.

id
string<uuid>
required
Example:

"8e1a7f50-90ab-4cde-8012-3456789abcde"

url
string<uri>
required

HTTPS URL that receives deliveries.

Example:

"https://hooks.example.com/endstate"

event_types
string[]
required

Event types this endpoint is subscribed to.

Example:
description
string | null
required
status
enum<string>
required

disabled on the first failed delivery after fail_since is five days old, after a 410 response, or when deleted. Re-enable with PATCH.

Available options:
enabled,
disabled
Example:

"enabled"

disabled_reason
string | null
required
fail_since
string<date-time> | null
required

When the current run of failed deliveries began, or null while deliveries succeed. The next failed delivery after this is five days old disables the endpoint, so fix the receiver before then.

Example:

null

api_version
string
required

Dated payload version this endpoint receives.

Example:

"2026-09-01"

created_at
string<date-time>
required
updated_at
string<date-time>
required