Skip to main content
← Back to API Selector

Server-Sent Events (SSE)

Real-time server-to-client event streaming. Perfect for notifications, live feeds, and status updates.

Connection

disconnected

Event Types

Settings

Events (0)

Auto-scrolls to latest

No events yet

Click Connect to start receiving events

API Documentation

Endpoint

GET /api/sse

Query Parameters

  • events - Event types (comma-separated)
  • interval - Ms between events (500-10000)
  • count - Max events before close
  • include_errors - Include error events
  • last_event_id - Resume from ID

Event Types

  • connected - Initial connection event
  • message - General messages
  • notification - Push notifications
  • update - Data changes (CRUD)
  • heartbeat - Keep-alive ping
  • error - Error simulation
  • close - Stream closing

Example (JavaScript)

const sse = new EventSource('/api/sse');

sse.addEventListener('message', (e) => {
  console.log(JSON.parse(e.data));
});

sse.addEventListener('notification', (e) => {
  console.log('Notification:', e.data);
});

sse.onerror = () => {
  console.log('Connection error');
};