Real Time Events

Real time features

Quick Sync provides real time features via SignalR Hubs using the WebSocket protocol.

Hubs

  • /v1/hubs/session

  • /v1/hubs/notepad

  • /v1/hubs/chat

Connecting to a hub

Use one of the SignalR clients to connect to the hubs

Authentication

On the hubs authentication tokens need to be placed in the query parameter

?access_token=<JWT-TOKEN>

Session Hub

The session hub provides real time information of session events.

URL: /v1/hubs/session

Events:

UserAdded,
UserRemoved,
SessionExpired,
SessionDestroyed,
FileRemoved,
FileProgress,
FileAdded,
FileComplete

The event payload is:

{
  "sessionId": "",
  "eventType": "",
  "data": {
    <event payload>
  }
}

Notepad Hub

Coming soon.

Chat Hub

Coming soon.

Last updated