WebSocket Events

All frames are JSON text frames. The top-level key identifies the message type.

For a full description of the protocol, lifecycle, and examples, see Push Notifications & Real-Time Updates.

---

Message types

Message	Direction	Purpose
subscribe	Client → Server	Subscribe to state change notifications for an accountId
subscribed	Server → Client	Confirms a successful subscription
stateChange	Server → Client	Notifies the client that one or more JMAP data types have a new state
error	Server → Client	Indicates a request could not be processed

Error codes

Code	Meaning
forbidden	The authenticated user cannot access the requested accountId
invalidArguments	The message could not be parsed or a required field is missing