v1

latestOpenAPI 3.1.02026-07-26202027.9 KB
Webhooks

Create a webhook subscription

Subscribes a callback URL to a webhook event type. Use GET /events to discover valid event_name values.

post/events/subscription

Request body

event_namestring required

The event type to subscribe to, e.g. payout.updated.

callback_urlstring uri required

The URL to deliver events to.

Response

The subscription was created.

Example response

{
  "data": {
    "subscription": {
      "eventName": "payout.updated"
    }
  }
}