Skip to content

Latest commit

 

History

History
12 lines (10 loc) · 1.12 KB

WEBSOCKET.md

File metadata and controls

12 lines (10 loc) · 1.12 KB
Raw

Logseq Sync WebSocket Endpoint

The Logseq Sync protocol features a WebSocket-based endpoint at /file-sync?graphuuid=<graph ID>, which serves to notify a client of changes from other clients (and itself).

  • The default websocket URL used in Logseq is wss://ws.logseq.com/file-sync?graphuuid=%s
    • The graphuuid query param is the UUID of the graph, which makes sense
  • The official Logseq Sync implementation doesn't verify that a graph with the given UUID exists
    • It does error out when the graphuuid query param is missing
  • The client periodically (how frequently?) sends a PING request to the server
  • When an update occurs (on what endpoint?), the server sends a message to all the clients (including the one which triggered the update) that have an open WebSocket connection for the updated graph
    • The format of the message is same as the response from the /get_txid api call, e.g {"TXId":<a number>}