Skip to main content
PATCH
Update a webhook subscription

Authorizations

X-API-Key
string
header
required

Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.

Path Parameters

id
string<uuid>
required

Resource UUID

Body

application/json
url
string<uri>

Must use https:// on port 443, carry no embedded credentials, and resolve to a public IP address.

Maximum string length: 2048
description
string | null
Maximum string length: 255
isActive
boolean

Inactive subscriptions are skipped by the delivery pipeline

Response

Updated subscription

data
object
required
meta
object
required