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.

Open source AsyncAPI → All Convex channels Convex provider profile
Provider: Convex AsyncAPI: v2.6.0 Spec: Convex Sync Protocol Operations: 2 Messages: 13

Channel address

/api/{clientVersion}/sync

Parameters

Operations

publish
clientToServer
Messages published by the client SDK to the Convex sync worker.
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 Agent Skill and MCP server surfaces of the same providers.

Work with this as data

Every channel here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for event channels

4 MCP tools reach this
  • find_channelsBrowse and filter every channel in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This channel 
curl "https://apis.io/api/v1/channels/api-clientversion-sync"
All event channels 
curl "https://apis.io/api/v1/channels?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.