Skip to main content
GET
/
v1
/
webhooks
/
{id}
Get a webhook subscription
curl --request GET \
  --url http://localhost:8080/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "whs_cq1234567890abcdef",
  "merchant_id": "<string>",
  "url": "<string>",
  "events": [
    "payout.created"
  ],
  "status": "active",
  "version": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Merchant API key: ak_live_... or ak_test_...

Path Parameters

​
id
string
required

Resource identifier (xid format)

Response

200 - application/json

Subscription details

​
id
string
Example:

"whs_cq1234567890abcdef"

​
merchant_id
string
​
url
string<uri>
​
events
enum<string>[]
Available options:
payout.created,
payout.approved,
payout.processing,
payout.sent,
payout.completed,
payout.failed,
payout.cancelled,
payout.returned,
beneficiary.created,
beneficiary.updated,
beneficiary.deleted,
batch.uploaded,
batch.completed,
batch.failed,
balance.low,
funding.credit,
screening.hit
​
status
enum<string>
Available options:
active,
inactive
​
version
string
​
metadata
object
​
created_at
string<date-time>
​
updated_at
string<date-time>