The single multiplexed WebSocket channel for an Instant app session.
The client publishes operation messages (init, add-query, transact,
presence, room, broadcast) and subscribes to the server's
acknowledgements and pushed novelty. Messages are correlated with a
client-generated `client-event-id`.
Operations the client Reactor sends to the sync server.
subscribe
receiveServerOps
Operations the sync server pushes to the client.
Messages
init
Authenticate and open the session.
Content-Type: application/json
add-query
Register an InstaQL query for live updates.
Content-Type: application/json
remove-query
Unsubscribe from a query
Content-Type: application/json
transact
Send InstaML transaction steps over the socket.
Content-Type: application/json
join-room
Join a presence room
Content-Type: application/json
leave-room
Leave a presence room
Content-Type: application/json
set-presence
Publish this client's ephemeral presence into a room.
Content-Type: application/json
client-broadcast
Send an ephemeral topic event to others in a room.
Content-Type: application/json
init-ok
Session initialized
Content-Type: application/json
add-query-ok
Acknowledges a query subscription and returns initial results.
Content-Type: application/json
refresh-ok
Server-pushed updated results when underlying data changes.
Content-Type: application/json
transact-ok
Transaction committed
Content-Type: application/json
join-room-ok
Room joined
Content-Type: application/json
patch-presence
Incremental presence change for peers in a room.
Content-Type: application/json
refresh-presence
Full presence snapshot for a room.
Content-Type: application/json
server-broadcast
A topic event broadcast by another client in the room.
Content-Type: application/json
error
An error tied to a prior client op (by client-event-id).
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.