Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openxswitch.com/llms.txt

Use this file to discover all available pages before exploring further.

OpenXSwitch provides webhook notifications for multiple event flows across Wallet-as-a-Service and Smart Accounts. Each flow consists of a parent method with sub-methods representing the lifecycle, status, or progress of an event. These webhooks enable real-time updates for deposits, withdrawals, transfers, swaps, and balance activities within your application.

​
Parent Methods

Event FlowWallet-as-a-ServiceSmart Accounts
Depositdepositsmart-accounts:deposit
Withdrawalwithdrawsmart-accounts:withdraw
Internal Transferinternal_transfer—
Instant Swapinstant_swap—
Wallets—smart-accounts:wallets
Parent methods are used as the top-level event namespace, while sub-methods define the specific event state or action (e.g., pending, updated, success).

​
Best Practices

  1. Idempotent Processing: Ensure your webhook handlers are idempotent to avoid duplicate processing.
  2. Final Events Only: Update balances only on final events, Refer to the full list of supported events to identify valid final event types.
  3. Acknowledgment: Always respond with a 2xx HTTP status code within 1 minutes to acknowledge receipt.
  4. Security: Verify webhook payload signatures to ensure authenticity.