Skip to main content
POST
Create Webhook Subscription

Overview

Registers a webhook subscription. The response includes a signing secret shown only once - store it securely; you’ll need it to verify deliveries.
Authenticate with your API key - the same Authorization: Bearer YOUR_API_KEY you use for the rest of the API. You can also create and manage webhooks from your dashboard. Professional plan or higher is required.
currencies is optional - omit it to receive every supported currency, or pass a list (e.g. ["USD","JPY"]) to receive only those. The url must be a public HTTPS endpoint.

Authorizations

Authorization
string
header
required

API key authentication using Bearer token

Body

application/json
url
string<uri>
required

HTTPS endpoint to receive deliveries. Public host only (no localhost/private IPs).

currencies
string[]

Optional list of currency codes to receive. Omit for all currencies.

description
string

Optional label.

Response

Subscription created