Skip to main content
POST
Create subscription
Register a delivery URL.
The response includes secret (a whsec_… signing secret) once. Store it on receipt — only the secretPrefix is retrievable later.
Scope webhooks:write · rate-limited

Headers

string
required
API key.

Request body

string
required
Endpoint URL. Must be https://. Rejected with 400 if it’s a private IP, loopback, or metadata host.
string[]
required
Non-empty list of event types. Allowed: payout.created, payout.status.updated.
string
Optional human-readable label for the dashboard. Never sent to your endpoint.

Response

string
Subscription UUID.
string
The signing secret in plaintext. Returned only on create — store it immediately.
string
First few characters of the secret for partner-side identification on subsequent reads.
string
Always active on a new subscription.
The other fields (url, events, label, lastSuccessAt, lastFailureAt, createdAt, updatedAt) match the shape on List subscriptions.

Errors