WebSocket Example

Demonstrates real-time WebSocket support alongside REST APIs.

Source: examples/websocket/

Key Concepts Demonstrated

• Two-phase authentication — JWT sent over encrypted WebSocket, not query params
• Connection lifecycle — $connect, $disconnect, $default handlers
• Connection store — connectionStore from @venturekit/runtime
• Send to user — deliver messages to a specific user across sessions
• Broadcast — send to all authenticated connections
• Tenant-scoped messaging — sendToTenant() for multi-tenancy
• Idle timeout — configurable connection timeout
• REST + WebSocket — both APIs in the same project

WebSocket Config

websocket: {
  enabled: true,
  routeSelectionExpression: '$request.body.action',
  idleTimeoutSec: 600,
  throttleRateLimit: 100,
}

Message Format

{ "action": "auth", "token": "<jwt>" }
{ "action": "ping" }
{ "action": "broadcast", "data": { "text": "Hello!" } }
{ "action": "send", "to": "<userId>", "data": { "text": "Hi!" } }

Run It

cd examples/websocket
npm install
vk dev

# Connect with wscat
wscat -c "wss://<ws-api-id>.execute-api.eu-west-1.amazonaws.com/dev"
> {"action": "auth", "token": "<jwt>"}

Related

• WebSocket Guide
• @venturekit/runtime — connectionStore