v1

latestOpenAPI 3.1.02026-08-0671638.9 KB

Update Webhook

Updates an existing webhook configuration. The webhook will be deactivated and a new activation test will be sent. The webhook will only become active again if the new endpoint responds successfully to the activation test.

put/api/v1/cash/webhooks/active

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

idinteger required

Webhook configuration ID to update

endpoint_urlstring uri required

New webhook endpoint URL

Example request

{
  "id": 456,
  "endpoint_url": "https://new-webhook-endpoint.com/webhooks"
}

Response

Webhook updated successfully and activation test initiated

event'webhook.updated'

Event type identifier

idinteger

Webhook configuration ID

endpoint_urlstring uri

Updated webhook endpoint URL

secret_tokenstring

64-character hexadecimal secret token (unchanged)

updated_atstring date-time

ISO 8601 timestamp of last update

Example response

{
  "event": "webhook.updated",
  "id": 456,
  "endpoint_url": "https://new-webhook-endpoint.com/webhooks",
  "secret_token": "644530cd9b0b431e61b8c6c656d17c77481047215a3ac66db71a7ad490397f7c",
  "updated_at": "2025-01-15T11:30:00Z"
}