v3

latestOpenAPI 3.0.32026-07-31489099.0 KB

Webhooks

Update webhook subscription

Updates URL and/or subscribed event types for an active subscription. When events is sent, it replaces the full set. Archived subscriptions return 409.

patch/accounts/{account_id}/webhooks/subscriptions/{subscription_id}

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

subscription_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Webhook subscription ID

Request body

eventsstring[] nullable

When present, replaces all subscribed event types. Supports concrete types (e.g. transfer.created) and namespace wildcards (e.g. transfer.*).

urlstring nullable

HTTPS URL to receive signed webhook POST requests

Response

eventsstring[] required

idstring required

ID of the resource

status'active' | 'archived' required

Subscription lifecycle: active deliveries or archived (no longer used).

urlstring required

Example response

{
  "id": "2VZvtmVc2j3gQ80CTlcuQXbGrwC"
}