v1

latestOpenAPI 3.1.02026-08-06173665.4 KB

Register a webhook for a client

Endpoint to register a new URL where the specified client will receive webhooks. Requires Authorization: Bearer <token> headers.

post/v1/clients/{clientId}/webhooks

Path parameters

clientIdstring uuid required

Client UUID for which the webhook is being registered.

Request body

client_idstring required

urlstring uri required

tokenstring required

webhook_type'MONEY_IN' | 'STATUS_UPDATE' | 'CEP' | 'REPORT' required

Example request

{
  "client_id": "{{clientId}}",
  "url": "https://example.com/webhook",
  "token": "secretToken0123",
  "webhook_type": "CEP"
}

Response

Webhook successfully created

idstring

clientIdstring

urlstring

tokenstring

webhookTypestring

webhookStatusstring

createdAtstring date-time

updatedAtstring date-time

deletedAtstring nullable

blockedAtstring nullable

deletedBystring nullable

blockedBystring nullable

Example response

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