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). Review the webhook safeguards upgrade notice. Successful subscription creation does not guarantee delivery: HTTPS is enforced for live events at send time, DNS is rechecked, and the signing secret must be usable.
The signing secret is returned only in this response. Store it securely — it cannot be retrieved again, only rotated.

Request Body

string
required
The final public endpoint that accepts POST without redirecting. Live deliveries require HTTPS and valid TLS; sandbox deliveries may use public HTTP. Internal addresses, URL credentials and fragments are rejected. Redirects are not followed.
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).