v1

latestOpenAPI 3.1.02026-08-0671638.9 KB

Create Webhook

Allows authenticated clients to configure webhook endpoints for receiving real-time notifications about operation status changes. The webhook is only activated if the activation test is successful.

Webhook Events: After configuration, your endpoint will receive:

Activation test: See WebhookActivationEvent schema below
Status updates: See OperationStatusUpdateEvent schema below

Note: Only one active webhook is allowed per client. Creating a new webhook will deactivate any existing ones after successful activation.

post/api/v1/cash/webhooks

Headers

X-Client-Idstring required

Client API key (32-character hex)

X-Signaturestring required

HMAC-SHA256 signature generated using api_secret

X-Timestampstring required

Unix timestamp (seconds since epoch)

Request body

endpoint_urlstring uri required

The webhook endpoint URL where notifications will be sent (must use http or https protocol)

Example request

{
  "endpoint_url": "https://your-webhook-endpoint.com/webhooks"
}

Response

Webhook configured successfully. An activation test will be sent to your endpoint. The webhook will be marked as active only if your endpoint responds successfully to the test.

event'webhook.created'

Event type identifier

idinteger

Unique identifier for the webhook configuration

endpoint_urlstring uri

The configured webhook endpoint URL

secret_tokenstring

64-character hexadecimal secret token for webhook signature verification

created_atstring date-time

ISO 8601 timestamp of webhook configuration creation

Example response

{
  "event": "webhook.created",
  "id": 456,
  "endpoint_url": "https://your-webhook-endpoint.com/webhooks",
  "secret_token": "644530cd9b0b431e61b8c6c656d17c77481047215a3ac66db71a7ad490397f7c",
  "created_at": "2025-01-15T10:30:00Z"
}