v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-013469188.5 KB
Webhooks

Send a test webhook to the configured URL

Sends a single webhook with fixture data to the client's configured URL. Uses the client's real webhook secret so signature verification works as in production. Envelope and persisted payload both carry "test": true so the receiver can filter and the dashboard can mark it.

post/webhooks/test

Headers

x-api-keystring required

API key for authentication

Example:your-api-key

API key for authentication

x-api-versionstring

API version identifier (e.g. "2026-04.amazon"). Optional today, will become required in a future release.

Example:2026-04.amazon

API version identifier (e.g. "2026-04.amazon"). Optional today, will become required in a future release.

Request body

type'deposit-received' | 'bridge-started' | 'bridge-delayed' | 'bridge-complete' | 'bridge-failed' | 'deposit-rejected' | 'deposit-delayed' | 'deposit-refunded' | 'onramp-order' | 'error' required

Which webhook type to simulate

Example request

{
  "type": "bridge-started"
}

Response

Test webhook dispatched

messagestring required
eventIdstring required