Skip to main content
POST
curl

Authorizations

API-Key
string
header
required

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

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

API-Sign
string
header
required

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

Headers

Idempotency-Key
string<uuid>

Client-generated UUIDv4 for safe retries. Sent as the Idempotency-Key HTTP header. Replayed responses include the Idempotent-Replayed: true header.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

webhook_id
string
required

Unique identifier for the webhook

Example:

"WHTEST-XXXXX-EXAMPLE"

Body

application/json
event
enum<string>
required

Event type to send as a test.

Available options:
quote.executed,
quote.cancelled,
quote.execution_failed,
user.closed,
user.disabled,
user.verified,
user.verification_failed,
user.verification_needed,
conversion.deposit_completed,
conversion.deposit_failed,
conversion.deposit_held,
conversion.quote_execution_failed,
conversion.withdrawal_completed,
conversion.withdrawal_failed
Example:

"quote.executed"

Response

Test webhook sent (check result for delivery status)

data
object
required