List available webhook event types

GET

https://api.useroot.com/api/webhooks/event-types

GET

/api/webhooks/event-types

$ curl https://api.useroot.com/api/webhooks/event-types \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "data": [
3     {
4       "type": "payout.debited",
5       "description": "Triggered when funds are debited from the sender's account"
6     },
7     {
8       "type": "payout.settled",
9       "description": "Triggered when the payout is successfully settled to the recipient"
10     },
11     {
12       "type": "payout.failed",
13       "description": "Triggered when a payout fails during processing"
14     },
15     {
16       "type": "payin.settled",
17       "description": "Triggered when a payin is successfully settled and funds are received"
18     },
19     {
20       "type": "payin.failed",
21       "description": "Triggered when a payin fails during processing"
22     },
23     {
24       "type": "subaccount.credit_received",
25       "description": "Triggered when an inbound credit is received on a virtual subaccount"
26     }
27   ],
28   "warning": null
29 }

Returns the canonical event type strings that may be used in webhook configuration subscriptions.

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Response

Successful Response

datalist of objects

warningstring or null