Guides
Realtime (SignalR)
Console events over SignalR for dashboards you build.
A dashboard you build can receive live events from the console hub at
/api/v1/console/realtime (SignalR).
- Pass the console JWT in the
access_tokenquery parameter (accepted on this path only). - The hub has one client method,
event. Its payload carries ids only — re-fetch the resource over HTTP to get the data. - You join only the topics your role and plan allow.
import * as signalR from '@microsoft/signalr';
const conn = new signalR.HubConnectionBuilder()
.withUrl('https://staging-api.panoptesos.com/api/v1/console/realtime', {
accessTokenFactory: () => accessToken,
})
.withAutomaticReconnect()
.build();
conn.on('event', (e) => console.log(e));
await conn.start();
For server-to-server integrations, use Webhooks instead.