Skip to main content
PATCH
Update webhook

Authorizations

X-API-Key
string
header
default:YOUR_API_KEY
required

Canonical API-key credential. Send X-API-Key: cns_pk_..., or Authorization: Bearer cns_pk_... only as an API-key compatibility alias.

Path Parameters

id
string
required

Webhook subscription ID.

Body

application/json
url
string<uri>

Replacement HTTPS endpoint URL.

status
enum<string>

Enable or disable delivery.

Available options:
active,
disabled
eventTypes
enum<string>[]

Replacement subscribable event types. On update, omitted eventTypes leaves the current value unchanged; null or an empty array resets to agreement.transitioned.

Available options:
agreement.transitioned,
agreement.notification.triggered
filters
object | null

Replacement filters. On update, omitted filters leaves the current value unchanged; null or an empty object erases every filter, after which the subscription receives every event it is subscribed to.

Response

Updated webhook subscription.

data
object
required
Example:
meta
object
required