Realtime Events

Subscribe to realtime updates for work items, projects, and more.

Overview

Fairlx provides realtime event subscriptions so your application can react to changes instantly:

  • Work item updates
  • Sprint changes
  • Comment notifications
  • Member activity

Subscribing to Events

Connect to the realtime endpoint and subscribe to channels:

Realtime Subscription
javascript
import { Realtime } from '@fairlx/sdk';

const realtime = new Realtime('YOUR_API_KEY');

realtime.subscribe('workitems', (event) => {
  console.log('Work item updated:', event);
});

realtime.subscribe('projects.PROJECT_ID', (event) => {
  console.log('Project event:', event);
});

Event Types

  • workitem.created — New work item created
  • workitem.updated — Work item modified
  • workitem.deleted — Work item removed
  • sprint.started — Sprint began
  • sprint.completed — Sprint finished
  • comment.added — New comment posted
Note
Realtime connections require an active API key with appropriate permissions.