Skip to main content
POST
Registers a webhook endpoint. Returns a signing secret — store it securely, it is only shown once.

Request body

string
required
The HTTPS URL to receive webhook events.
array
List of event types to subscribe to. Defaults to all events if omitted.Available events:
  • transfer.quote_created
  • transfer.deposit_confirmed
  • transfer.processing
  • transfer.hop_complete
  • transfer.completed
  • transfer.failed
  • transfer.expired
  • transfer.refunded
  • payout.completed

Response

integer
Webhook endpoint ID.
string
The registered URL.
string
HMAC-SHA256 signing secret prefixed with whsec_. Shown once — store this securely.
array
Subscribed event types.