Update a webhook subscription

Changes a subscription's URL, event types or pinned api_version, or pauses and resumes it through status (active or paused). Only the fields sent are changed. Pausing cancels every delivery still waiting, and events that occur while paused are not queued; after resuming, catch up from GET /v1/changes starting from a cursor taken before the pause. Idempotency-Key is required. Requires the webhooks:write OAuth scope. The credential's user needs the manage_integrations permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Fields accepted to update a webhook subscription. The schema identifies required and optional values.

PATCH /v1/webhook-subscriptions/{id} — sparse: every field is optional,
event_types replaces the whole list, api_version applies to deliveries
rendered from now on, and status pauses or resumes the subscription.

string
length ≤ 2048
string | null
string
enum
Allowed:
string
enum
Allowed:
event_types
array of strings
length between 1 and 300
event_types
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*