Skip to main content
POST
Send webhook test event

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Path Parameters

webhook_id
string
required

Identifier returned by CreateWebhook.

Required string length: 1 - 64

Body

application/json

Request to send a test event to a webhook.

The owning tenant is derived from the authenticated caller. Only the webhook id and the event type are supplied.

event
enum<string>
required

Event type to send an example of. The test delivery's payload uses representative placeholder values in the shape of a real event of this type. The funds.deposit_*, funds.withdrawal_held, funds.withdrawal_complete, and funds.withdrawal_failed test events include example amount and fee objects with asset and decimal-string value fields; the example fee is included when it is zero. In live deliveries, amount is included when resolvable and fee is included only when fee data is available and resolvable.

Available options:
quote.executed,
quote.cancelled,
quote.execution_failed,
user.closed,
user.disabled,
conversion.deposit_completed,
conversion.deposit_failed,
conversion.deposit_held,
conversion.withdrawal_completed,
conversion.withdrawal_failed,
conversion.quote_execution_failed,
conversion.travel_rule_blocked,
transaction.swap,
transaction.price_trigger_swap,
transaction.earn_reward,
transaction.deposit,
transaction.withdrawal,
transaction.transfer,
conversion.quote_executed,
funds.deposit_received,
funds.deposit_held,
funds.deposit_credited,
funds.deposit_returned,
funds.deposit_failed,
verification.requirements_updated,
verification.updated,
price_trigger_swap.executed,
price_trigger_swap.execution_failed,
price_trigger_swap.cancelled,
price_trigger_swap.created,
price_trigger_swap.failed,
funds.withdrawal_held,
funds.withdrawal_complete,
funds.withdrawal_failed,
recurring_swap.created,
recurring_swap.executed,
recurring_swap.execution_failed,
recurring_swap.cancelled,
recurring_swap.failed,
recurring_swap.paused,
recurring_swap.resumed,
transaction.recurring_swap

Response

Successful response

Response from SendWebhookTestEvent.

A successful response means the test message was accepted for delivery, not that the destination URL has already received it; delivery happens asynchronously with the usual retry schedule.

data
object
required

Data envelope returned after a successful SendWebhookTestEvent.