Webhooks

List client webhooks

Changed on Sep 26, 2026

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

get/v1/clients/{clientId}/webhooks

Request

Base URL
https://apicore.stg.finch.lat
Auth
HTTP bearer
TypeScript
https://skmtc.dev/monato/apis/fincore-api/docs/v1/clients/:clientId/webhooks/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

clientIdstring uuid required

Client UUID that owns the webhooks.

Response

List of client webhooks

currentPageinteger required

Current page number.

perPageinteger required

Number of webhook configurations returned per page.

totalIteminteger required

Total number of webhook configurations matching the request.

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

Changes

Sep 26, 2026e22ef66945df Revision changes
- warning
  added the new ACTIVE enum value to the // response property for the response status
- warning
  added the new CEP enum value to the // response property for the response status
- warning
  added the new INACTIVE enum value to the // response property for the response status
- warning
  added the new MONEY_IN enum value to the // response property for the response status
- warning
  added the new REFUND enum value to the // response property for the response status
- warning
  added the new REPORT enum value to the // response property for the response status
- warning
  added the new STATUS_UPDATE enum value to the // response property for the response status
- info
  api tag Webhooks added
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status

Operation history