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
javascriptimport { 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 createdworkitem.updated— Work item modifiedworkitem.deleted— Work item removedsprint.started— Sprint begansprint.completed— Sprint finishedcomment.added— New comment posted
Note
Realtime connections require an active API key with appropriate permissions.
