List client webhooks

GET /v1/clients/{clientId}/webhooks

Base URL https://apicore.stg.finch.lat · operationId listClientWebhooks

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

Authorization

bearerAuth Bearer token

JWT bearer token created from client credentials. Use the Authentication guide to generate a token before calling protected endpoints.

Path parameters

clientId string (uuid) required

Client UUID that owns the webhooks.

Responses

200 List of client webhooks application/json

currentPage integer required

Current page number.

perPage integer required

Number of webhook configurations returned per page.

totalItem integer required

Total number of webhook configurations matching the request.

data array of WebhookResponse required

Webhook configurations returned for the client.

id data[].id string (uuid) required

Webhook configuration UUID.

clientId data[].clientId string (uuid) required

Client UUID that owns the webhook.

url data[].url string (uri) required

Destination URL where Monato sends webhook events.

token data[].token string

Secret configured for webhook delivery.

webhookType data[].webhookType string required

Type of events delivered to this webhook.

MONEY_IN STATUS_UPDATE CEP REPORT REFUND

webhookStatus data[].webhookStatus string required

Current webhook lifecycle status.

ACTIVE INACTIVE

createdAt data[].createdAt string (date-time)

Timestamp when the webhook configuration was created.

updatedAt data[].updatedAt string (date-time)

Timestamp when the webhook configuration was last updated.

deletedAt data[].deletedAt string | null

Timestamp when the webhook configuration was deleted, or null.

blockedAt data[].blockedAt string | null

Timestamp when the webhook configuration was blocked, or null.

deletedBy data[].deletedBy string | null

Identifier of the actor that deleted the webhook, or null.

blockedBy data[].blockedBy string | null

Identifier of the actor that blocked the webhook, or null.

400 Webhook list request is invalid. Possible causes: malformed clientId or invalid pagination/filter values. application/json

code integer required

gRPC status code mapped to HTTP.

message string required

General error message.

details array of ErrorDetail required

Detailed error causes returned by the service.

reason details[].reason string required

Machine-readable error category.

DATA_ERROR FAILED_PRECONDITION MISSING_REQUIRED_FIELDS RESOURCE_NOT_FOUND UNAUTHORIZED PERMISSION_DENIED UNIQUE_VIOLATION INTERNAL

domain details[].domain string required

Service domain that produced the error.

metadata details[].metadata object required

Additional error metadata, including the detailed message and HTTP code.

error_detail details[].metadata.error_detail string

Human-readable detail returned by the service.

http_code details[].metadata.http_code string

HTTP status code associated with this error.

error_code details[].metadata.error_code string

Optional internal error catalog code when available.

401 Missing, expired, invalid, or environment-mismatched API key or bearer token. See Authentication. application/json

code integer required

gRPC status code mapped to HTTP.

message string required

General error message.

details array of ErrorDetail required

Detailed error causes returned by the service.

reason details[].reason string required

Machine-readable error category.

DATA_ERROR FAILED_PRECONDITION MISSING_REQUIRED_FIELDS RESOURCE_NOT_FOUND UNAUTHORIZED PERMISSION_DENIED UNIQUE_VIOLATION INTERNAL

domain details[].domain string required

Service domain that produced the error.

metadata details[].metadata object required

Additional error metadata, including the detailed message and HTTP code.

error_detail details[].metadata.error_detail string

Human-readable detail returned by the service.

http_code details[].metadata.http_code string

HTTP status code associated with this error.

error_code details[].metadata.error_code string

Optional internal error catalog code when available.

500 Unexpected server error. See Error catalog before retrying non-idempotent operations. application/json

code integer required

gRPC status code mapped to HTTP.

message string required

General error message.

details array of ErrorDetail required

Detailed error causes returned by the service.

reason details[].reason string required

Machine-readable error category.

DATA_ERROR FAILED_PRECONDITION MISSING_REQUIRED_FIELDS RESOURCE_NOT_FOUND UNAUTHORIZED PERMISSION_DENIED UNIQUE_VIOLATION INTERNAL

domain details[].domain string required

Service domain that produced the error.

metadata details[].metadata object required

Additional error metadata, including the detailed message and HTTP code.

error_detail details[].metadata.error_detail string

Human-readable detail returned by the service.

http_code details[].metadata.http_code string

HTTP status code associated with this error.

error_code details[].metadata.error_code string

Optional internal error catalog code when available.

This request is in the Monato · Fincore Postman collection, folder Webhooks.Download collection

Request

curl -X GET "https://apicore.stg.finch.lat/v1/clients/{clientId}/webhooks" \
  -H "Authorization: Bearer $TOKEN"

const res = await fetch("https://apicore.stg.finch.lat/v1/clients/{clientId}/webhooks", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${TOKEN}`,
  },
});
const data = await res.json();

import requests

res = requests.get(
    "https://apicore.stg.finch.lat/v1/clients/{clientId}/webhooks",
    headers={
        "Authorization": f"Bearer {TOKEN}",
    },
)
data = res.json()

Response

{
  "currentPage": 0,
  "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": null,
      "blockedAt": null,
      "deletedBy": null,
      "blockedBy": null
    }
  ]
}

{
  "code": 9,
  "message": "API Error",
  "details": [
    {
      "reason": "FAILED_PRECONDITION",
      "domain": "CORE",
      "metadata": {
        "error_detail": "The account does not have sufficient funds.",
        "http_code": "400",
        "error_code": "10-E4120"
      }
    }
  ]
}

{
  "code": 16,
  "message": "API Error",
  "details": [
    {
      "reason": "UNAUTHORIZED",
      "domain": "CORE",
      "metadata": {
        "error_detail": "Invalid Credentials",
        "http_code": "401"
      }
    }
  ]
}

{
  "code": 9,
  "message": "API Error",
  "details": [
    {
      "reason": "FAILED_PRECONDITION",
      "domain": "CORE",
      "metadata": {
        "error_detail": "The account does not have sufficient funds.",
        "http_code": "400",
        "error_code": "10-E4120"
      }
    }
  ]
}