Realtime UI with Echo

Wire server broadcasts to a browser client using the native WebSocket driver.

Server

// config/broadcasting.ts
export default {
  default: env('BROADCAST_CONNECTION', 'websocket'),
  connections: {
    websocket: {
      driver: 'websocket',
      redisConnection: env('REDIS_CONNECTION', 'default'),
      channel: env('BROADCAST_REDIS_CHANNEL', 'tyravel:broadcast'),
      path: '/tyravel/ws',
    },
  },
};

// src/main.ts
import { WebSocketBroadcastServiceProvider } from '@tyravel/broadcasting-websocket';

Authorize private channels in routes/channels.ts using private- prefixes to match Echo conventions.

Client

import { Echo } from '@tyravel/echo';

const echo = new Echo({
  broadcaster: 'websocket',
  host: window.location.host,
  path: '/tyravel/ws',
});

echo.private(`users.${userId}`).listen('NotificationSent', (event) => {
  console.log(event);
});

Debugging

• tyravel route:list --json — confirm /broadcasting/auth is registered
• Redis required for multi-process fan-out
• See 0.13 migration notes if upgrading from Socket.io