> For the complete documentation index, see [llms.txt](https://docs.quicksync.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.quicksync.me/qs-framework/real-time-events.md).

# Real Time Events

Real time features

Quick Sync provides real time features via [SignalR ](https://dotnet.microsoft.com/en-us/apps/aspnet/signalr)Hubs using the WebSocket protocol.&#x20;

## Hubs

* /v1/hubs/session
* /v1/hubs/notepad
* /v1/hubs/chat

### Connecting to a hub&#x20;

Use one of the [SignalR clients](https://learn.microsoft.com/en-us/aspnet/core/signalr/client-features?view=aspnetcore-9.0) to connect to the hubs

#### Authentication

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

`?access_token=<JWT-TOKEN>`&#x20;

## 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&#x20;

Coming soon.

## Chat Hub

Coming soon.
