WebSocket API

Along with the REST API, Oblecto also supports a websocket based api over Socket.IO to allow for realtime communication between Oblecto Clients and the backend. It is used for realtime episode and movie tracking and for real-time library updates on frontends. The channel refers to the Socket.IO channel based communication.

Authentication

Channel: authenticate
Message:

{
    "token": "JWT token retrieved from the REST API"
}

Tracking

Channel: playing
Message:

{
    "episodeId": "id of episode | only needed if tracking episode",
    "movieId": "id of the movie | only needed if tracking movie",
    "progress": "percentage watched of video",
    "time": "seconds since start of video"
}