MOmonato
Webhooks

Register a webhook for a client

Changed on

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

post/v1/clients/{clientId}/webhooks

Request

Path parameters

clientIdstring uuid required

Client UUID for which the webhook is being registered.

Request body

client_idstring uuid required

Client UUID that owns the webhook configuration.

urlstring uri required

Public HTTPS URL where Monato sends webhook events.

tokenstring required

Secret sent by Monato in webhook delivery requests. Use a random value of at least 32 bytes.

webhook_type'MONEY_IN' | 'STATUS_UPDATE' | 'CEP' | 'REPORT' | 'REFUND' required
auth_type'AUTH' | 'NO_AUTH' | 'OAUTH' required

Authentication mode for outbound webhook delivery.

Example request

{
  "client_id": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
  "url": "https://example.com/webhook",
  "token": "secretToken0123",
  "webhook_type": "MONEY_IN",
  "auth_type": "AUTH"
}

Response

Webhook successfully created

idstring uuid required

Webhook configuration UUID.

clientIdstring uuid required

Client UUID that owns the webhook.

urlstring uri required

Destination URL where Monato sends webhook events.

tokenstring

Secret configured for webhook delivery.

webhookType'MONEY_IN' | 'STATUS_UPDATE' | 'CEP' | 'REPORT' | 'REFUND' required
webhookStatus'ACTIVE' | 'INACTIVE' required
createdAtstring date-time

Timestamp when the webhook configuration was created.

updatedAtstring date-time

Timestamp when the webhook configuration was last updated.

deletedAtstring nullable

Timestamp when the webhook configuration was deleted, or null.

blockedAtstring nullable

Timestamp when the webhook configuration was blocked, or null.

deletedBystring nullable

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

blockedBystring nullable

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

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

Changes

  • e22ef66945dfRevision changes
    • breaking

      added the new required request property

    • breaking

      the request property format changed from no format to uuid

    • 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 new REFUND enum value to the request property

    • 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