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

  • Base URL
    https://payouts.api.trykarat.com
  • Auth
    HTTP bearer

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"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.