v1

latestOpenAPI 3.1.02026-08-06173665.4 KB

List client webhooks

Returns a paginated list of webhooks configured for the specified client.

get/v1/clients/{clientId}/webhooks

Path parameters

clientIdstring uuid required

Client UUID that owns the webhooks.

Response

List of client webhooks

currentPageinteger required
perPageinteger required
totalIteminteger required

Example response

{
  "perPage": 50,
  "totalItem": 2,
  "data": [
    {
      "id": "29806117-2b15-4682-87f0-350e6695fe91",
      "clientId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
      "url": "https://example.com/webhook",
      "token": "secretToken0123",
      "webhookType": "MONEY_IN",
      "webhookStatus": "ACTIVE",
      "createdAt": "2025-04-03 13:40:54.056794-06:00",
      "updatedAt": "2025-04-03 13:40:54.056794-06:00",
      "deletedAt": "None",
      "blockedAt": "None",
      "deletedBy": "None",
      "blockedBy": "None"
    }
  ]
}