Skip to main content
POST
/
webhooks
cURL
curl --request POST \
  --url https://sandbox.onconsul.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "deposit.created"
  ],
  "url": "<string>"
}
'
{
  "active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "events": [
    "deposit.created"
  ],
  "id": "<string>",
  "url": "<string>"
}
Register a webhook endpoint to receive event notifications. Provide a URL and the list of event types you want to subscribe to.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
events
enum<string>[]
required
Available options:
deposit.created,
deposit.updated,
inbound_transfer.created,
payout.created,
payout.updated,
withdrawal.created,
withdrawal.updated,
recipient.created,
recipient.updated
​
url
string<uri>
required

Response

OK

​
active
boolean
required
​
created_at
string<date-time>
required
​
events
enum<string>[]
required
Available options:
deposit.created,
deposit.updated,
inbound_transfer.created,
payout.created,
payout.updated,
withdrawal.created,
withdrawal.updated,
recipient.created,
recipient.updated
​
id
string
required
​
url
string<uri>
required