Sign in

v3

latestOpenAPI 3.0.32026-07-31489099.0 KB
Webhooks

Create webhook subscription

Registers a destination URL and one or more event types. The signing secret is returned once in the response.

post/accounts/{account_id}/webhooks

Path parameters

account_idstring required

ID of the resource

Example:2VZvtmVc2j3gQ80CTlcuQXbGrwC

Account ID

Request body

eventsstring[] required

Event types to subscribe to. Supports concrete types (e.g. transfer.created) and namespace wildcards (e.g. transfer.* for all transfer events). See the supported event types endpoint.

urlstring required

HTTPS URL to receive signed webhook POST requests

Response

Created

eventsstring[] required
idstring required

ID of the resource

sharedSecretstring required

Signing secret (Base64 Encoded). Returned only on create; store it securely to verify signatures.

status'active' | 'archived' required

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

urlstring required

Example response

{
  "id": "2VZvtmVc2j3gQ80CTlcuQXbGrwC"
}