At Misakey, realtime is managed through websockets or polling. We aim at manage our whole realtime through websockets.
The websockets protocol uses the same handshake as http requests.
Servers can differenciate them thanks to the
Connection: Upgrade header.
Our server send regular (every 60 seconds)
Pings to check the connection state.
For now, there is no action triggered by a lack of a
Each user can subscribe to
wss://api.misakey.com/box-users/:id/ws to have realtime messages.
All websockets messages are under the following format:
The most important use of realtime at Misakey is to manage new box events. Their type is
They are server to client messages.
Here are the events that can be received:
This message notifies a box deletion.
This message notifies an invitation.
This message notifies a box settings update.
This message notifies a change in the saved status of a file for a given user.
Server accepts only events of the type
These messages are sent when a user want to acknowledge the events count on a box.
This set the events count to 0 for the user on the box.