Skip to main content
POST
Creates a webhook subscription. Deliveries are signed — verify them with the returned secret and the SDK’s construct_event (see Webhook security).
The signing secret is returned only in this response. Store it securely — it cannot be retrieved again, only rotated.

Request Body

string
required
The HTTPS endpoint to deliver events to. Internal/private addresses are rejected.
string[]
required
The event types to subscribe to, e.g. ["deposit.completed", "payout.failed"].
string
An optional label for this subscription.
string[]
Optional list of source IPs allowed to receive deliveries.
string
Payload schema version. Defaults to the current version.

Response

string
The signing secret — shown once.
object
The created subscription (same shape as list subscriptions).