WebSocket events

The SpringCard Companion Service's WebSocket delivers push notifications when specific events occurs in the system or in the connected devices. The protocol is based on JSON RPC.

Their are 4 families of events:


All the events documented in this section are broadcasted to all the client application that are currently connected to the WebSocket.

If two instances of the very same application are running simultaneously, the event is likely to be processed twice. The implementer shall be take the appropriate countermeasures accordingly.

Also, care must be taken when implementing an application that new events are likely to be added in the future. The application shall ignore gracefully all the events it does not know.