# Convex Sync Protocol

**Canonical:** https://apis.io/apis/convex/sync-protocol/  
**Provider:** Convex — https://apis.io/providers/convex/  
**Base URL:** wss://{deployment-name}.convex.cloud/api/{clientVersion}/sync  
**Documentation:** https://docs.convex.dev/understanding/

Convex Sync Protocol is one of 14 APIs that [Convex](https://apis.io/providers/convex/) publishes on the [APIs.io](https://apis.io/) network, described by an AsyncAPI event-driven specification. Tagged areas include Real-Time, Reactive, Sync, and WebSocket. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

The Convex Sync Protocol is the bidirectional WebSocket protocol spoken between Convex client SDKs and the sync worker of a Convex deployment. Clients open a single WebSocket connection to wss://{deployment-name}.convex.cloud/api/{clientVersion}/sync and exchange JSON envelopes (discriminated by a `type` field) to authenticate, subscribe to reactive query sets, invoke mutations and actions, and receive query transitions, function responses, auth errors, fatal errors, and pings. The protocol is implemented in the open source convex-js client (`src/browser/sync/protocol.ts`).

## Machine-readable artifacts (4)

- **Documentation** — https://docs.convex.dev/understanding/
- **SourceCode** — https://github.com/get-convex/convex-js/blob/main/src/browser/sync/protocol.ts
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/convex/refs/heads/main/asyncapi/convex-asyncapi.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/convex/refs/heads/main/apis.yml

## Other Convex APIs (12)

- [Convex JavaScript SDK](https://apis.io/apis/convex/javascript-sdk/)
- [Convex Server SDK](https://apis.io/apis/convex/server-sdk/)
- [Convex AccessTokens API](https://apis.io/apis/convex/convex-accesstokens-api/)
- [Convex Actions API](https://apis.io/apis/convex/convex-actions-api/)
- [Convex CustomDomains API](https://apis.io/apis/convex/convex-customdomains-api/)
- [Convex DeployKeys API](https://apis.io/apis/convex/convex-deploykeys-api/)
- [Convex Deployments API](https://apis.io/apis/convex/convex-deployments-api/)
- [Convex EnvironmentVariables API](https://apis.io/apis/convex/convex-environmentvariables-api/)
- [Convex Functions API](https://apis.io/apis/convex/convex-functions-api/)
- [Convex Mutations API](https://apis.io/apis/convex/convex-mutations-api/)
- [Convex Projects API](https://apis.io/apis/convex/convex-projects-api/)
- [Convex Queries API](https://apis.io/apis/convex/convex-queries-api/)

## Tags

Real-Time, Reactive, Sync, WebSocket

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/convex/sync-protocol/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/convex/.