Skip to main content
PATCH
Update a webhook subscription

Headers

Idempotency-Key
string<uuid>
required

Client-generated unique key per operation intent (UUID). Same key + identical body replays the original response; same key + different body returns 409.

Path Parameters

webhook_id
string
required

Body

application/json
name
string
Maximum string length: 255
description
string | null
Maximum string length: 1000
url
string<uri>

HTTPS endpoint that deliveries are POSTed to.

status
enum<string>

Set PAUSED to pause deliveries or ACTIVE to resume them.

Available options:
ACTIVE,
PAUSED
custom_headers
object

Replaces the stored custom headers. Values are write-only and never returned.

rotate_secret
boolean

Set true to rotate the signing secret. The new secret is returned once in the response.

Response

webhook_id
string<uuid>
required

Platform-assigned stable identifier.

name
string
required

Human-readable name for the subscription.

url
string<uri>
required

HTTPS endpoint deliveries are POSTed to.

event
string
required

The event type this subscription receives.

status
enum<string>
required
Available options:
ACTIVE,
PAUSED,
FAILED
custom_header_names
string[]
required

Names of configured custom headers. Header values are never returned.

failure_count
number
required

Consecutive delivery failures since the last success.

created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
api_version
string | null

Pinned payload API version.

last_failure_at
string<date-time> | null
last_success_at
string<date-time> | null
last_status_code
number | null
last_delivery_at
string<date-time> | null
secret
string

The new signing secret — present only when secret rotation was requested. Shown once.