AsyncAPI channel · Convex
· Convex Sync Protocol
/api/{clientVersion}/sync
Single bidirectional WebSocket channel used by the Convex sync protocol. All client and server messages flow over this channel as JSON envelopes keyed by a `type` discriminator.
Channel address
/api/{clientVersion}/sync
Parameters
clientVersion— Version of the `convex` npm package the client was built against (the `version` export from `convex-js`). Sent verbatim in the URL path.
Operations
publish
clientToServer
Messages published by the client SDK to the Convex sync worker.
subscribe
serverToClient
Messages pushed by the Convex sync worker to the client SDK.
Messages
Connect
Opens or resumes a sync session.
Content-Type:
Authenticate
Supplies (or clears) the identity used to run queries, mutations, and actions.
Content-Type:
ModifyQuerySet
Adds or removes subscribed queries from the client's active query set.
Content-Type:
Mutation
Requests execution of a Convex mutation function.
Content-Type:
Action
Requests execution of a Convex action function.
Content-Type:
Event
Client-emitted telemetry / lifecycle event (e.g. `ClientConnect`).
Content-Type:
Transition
Advances the client from one server state version to the next, with per-query modifications.
Content-Type:
TransitionChunk
One chunk of a large `Transition` message split across multiple frames.
Content-Type:
MutationResponse
Result of a previously sent `Mutation` request.
Content-Type:
ActionResponse
Result of a previously sent `Action` request.
Content-Type:
AuthError
Authentication failure reported by the server.
Content-Type:
FatalError
Unrecoverable error; the server will close the connection.
Content-Type:
Ping
Liveness ping from the server.
Content-Type:
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.
Browse every event-driven channel on the APIs.io network or compare with the broader Naftiko capability, Agent Skill, and MCP server surfaces of the same providers.