How It Works
WireSocket is compatible with the Yjs CRDT protocol and any Yjs-compatible provider. When a user opens a collaborative document, WireSocket:- Verifies the JWT access token issued by your OAuth 2 application
- Routes the connection to the correct regional node where the document session lives
- Synchronizes all CRDT updates in real-time across every connected client in that region
Tenancy & Authentication
To use WireSocket, you:- Sign up and create an OAuth 2 application in the WireSocket dashboard
- Use your
client_idandclient_secretto obtain a short-lived JWT access token - Pass the token when connecting your Yjs provider to the WireSocket WebSocket endpoint
Regional Architecture
WireSocket nodes are deployed globally across multiple regions. However, a document session exists in exactly one region at a time — the region where the first client connected. If a subsequent client attempts to connect to a different region for the same document, WireSocket will return an error indicating the correct region. Your client should reconnect to the correct regional endpoint. This design keeps latency predictable and avoids the complexity and cost of cross-region CRDT merging.Compatible With
WireSocket speaks the Yjs sync protocol. Any library or editor that supports Yjs works out of the box.What WireSocket Is Not
- ❌ Not a document storage service
- ❌ Not an editor or UI component
- ❌ Not a platform with per-user management
- ❌ Not a lock-in strategy
Zero Vendor Lock-In
WireSocket is just a WebSocket endpoint. Your documents live in your database, your auth lives in your system, and your editor stays exactly as it is. Migrating away from WireSocket means changing one URL. That’s it. If you’d like to know how to migrate, refer to this page. No data export requests. No migration tools. No lock-in by design. We stay competitive by being good infrastructure, not by making it painful to leave.Get Started
Quickstart: Connect in 5 Minutes
Create an OAuth 2 application, generate an access token, and sync your first
document.

