Skip to main content
POST
Create Webhook

Authorizations

Authorization
string
header
required

Opaque API key passed as Authorization: Bearer <key>. Keys are organization-bound, environment-bound (live or test), scope-carrying, and expiring. Create and manage keys via the console.

Body

application/json
url
string<uri>
required

HTTPS URL where events will be delivered via POST.

Maximum string length: 2048
Pattern: ^https://.+
events
enum<string>[]
required

Event types to subscribe to. Current producers emit transactions.sync_available and connection.status_changed, and test can be triggered explicitly via the API. The remaining spec-defined event types are reserved for upcoming producers.

Minimum array length: 1
Available options:
connection.status_changed,
account.created,
account.updated,
transactions.sync_available,
transfer.status_changed,
test
metadata
Metadata · object | null

Opaque client-defined metadata.

Response

Successful Response

webhook
Webhook · object
required

The created webhook registration. The secret is shown in full only in this response.

meta
Meta · object
required