IBEx.Fi WebSocket Flow

1. Connection & Authentication Flow
🔌
Connect WebSocket
wss://api.ibex.fi/ws
WebSocket connection
🔐
Authenticate
{ type: 'auth', token: 'JWT' }
JWT validation
✅
Auth Success
auth_success message
Safe address confirmed
2. Initial Data Flow
💰
Balance Data
balance_data
Current wallet balance
📊
Transaction Data
transaction_data
Recent transactions (50)
⛓️
Chain ID Data
chainid_data
Default & supported chains
🔒
Recovery Data
recovery_data
Recovery status
👤
User Data
user_data
User info & Safe addresses
3. Real-Time Updates Flow
💰
Balance Update
balance_update
Balance changed
🔄
New Transaction
new_transaction
Transaction detected
🏦
IBAN Updated
user.iban.updated
IBAN status changed
✅
KYC Updated
user.ky.updated
KYC status changed
4. On-Demand Requests Flow
📤
Request Balance
{ type: 'get_balance' }
Client request
💰
Balance Response
balance_data
Current balance
5. On-Demand Transactions Flow
📤
Request Transactions
{ type: 'get_transactions', params: {...} }
Client request
📊
Transaction Response
transaction_data
Transaction history

📋 Message Types

  • auth : Authenticate with JWT
  • auth_success : Authentication successful
  • auth_error : Authentication failed
  • balance_data : Balance data
  • balance_update : Real-time balance update
  • transaction_data : Transaction data
  • new_transaction : New transaction notification
  • chainid_data : Chain ID information
  • recovery_data : Recovery status
  • user_data : User information
  • user.iban.updated : IBAN status change
  • user.ky.updated : KYC status change
  • get_balance : Request balance on demand
  • get_transactions : Request transactions on demand

🔧 Connection Details

  • Endpoint : wss://api.ibex.fi/ws
  • Authentication : JWT token (same as HTTP API)
  • Auto-subscription : Based on Safe address
  • Initial data : Sent automatically after auth
  • Real-time updates : Automatic for Safe address
  • Keep-alive : Server ping every 30s
  • Reconnection : Exponential backoff recommended

⚙️ Technical Details

  • WebSocket protocol (RFC 6455)
  • JWT authentication
  • BCReader integration
  • Automatic subscription management
  • Real-time blockchain updates
  • Status change notifications
← Back to WebSocket Guide