Schema Definition

This section provides an overview of the structure and fields used in Rocket.Chat schema. It aims to assist developers in understanding the data models and their relationship within the system.

• User: Schema structure for Rocket.Chat user data.

• Room: The schema structure for all Rocket.Chat rooms.

• Message: Structure of a Rocket.Chat message object.

• Subscription: The structure of how users relate to rooms.

How the schemas fit together

• A room is any conversation container: a channel, private group, direct message, or omnichannel conversation. Its t field states the type.

• A message always belongs to one room (its rid field) and one sender (its u field, a trimmed user).

• A subscription joins one user to one room. It carries the per-user view of the room: unread counts, alerts, favorite status, and notification preferences.

Shared conventions

• _id: Every document has a unique ID string. API endpoints reference these as userId, roomId (or rid), and msgId.

• ts holds the creation timestamp and _updatedAt the last modification. Timestamps are ISO 8601 date strings in API responses.

• Room types in the t field are single letters: c (channel), p (private group), d (direct message), and l (livechat/omnichannel).

• Embedded references are trimmed. For example, the u field on messages and subscriptions contains only _id, username, and sometimes name, not the full user document.