Skip to main content
PATCH
Update a webhook subscription

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Path Parameters

subscriptionId
string
required

Webhook subscription id

Body

application/json
url
string<uri>
Maximum string length: 2048
isActive
boolean
rotateSecret
boolean
eventTypes
string[]
Required array length: 1 - 100 elements
Required string length: 1 - 200

Response

{ success: true, subscription } (+ secret when rotateSecret: true)

success
boolean
required
{key}
any