RHrhinestonewtf
Webhooks

Send a test webhook

Changed on

Sends a webhook with test data to the configured URL.

post/webhooks/test

Request

Headers

x-api-keystring

API key for authentication

Example:your-api-key
x-api-versionstring

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

Example:2026-04.amazon

Request body

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

Which webhook type to simulate

Example request

{
  "type": "bridge-started"
}

Response

Test webhook dispatched

messagestring required
eventIdstring required

Changes

  • aa1767d704faRevision changes
    • info

      the endpoint scheme security internalProjectBearer was added to the API

    • info

      the endpoint scheme security tenantApiKey was added to the API

    • info

      the header request parameter x-api-key became optional

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 2a4550fcca0fRevision changes
    • breaking

      removed the enum value onramp-payment of the request property