Skip to main content
PATCH
Update a webhook subscription

Authorizations

X-API-KEY
string
header
required

Path Parameters

subscription_id
string
required

Body

application/json
url
string
events
enum<string>[]
Available options:
call_started,
call_completed,
recording_completed
description
string
status
enum<string>
Available options:
active,
disabled
headers
object

Replaces every header on this subscription.

signing_enabled
boolean

Turning it on mints a secret and returns it once. Turning it on when already on is a no-op, not a rotation. Turning it off clears the secret.

rotate_signing_secret
boolean

Mint a fresh secret and return it once.

payload_format
enum<string>
Available options:
native,
ringg

Response

Updated subscription. Carries signing_secret only when this request minted one.