The connector reads one Rocket.Chat workspace. It syncs the workspace’s
users, roles, and teams, along with each user’s workspace-level role
assignments and each team’s membership. Users sync as enabled or disabled
based on their active state in Rocket.Chat, and bot and app accounts are
labeled as service accounts. Users reached through Matrix federation are
marked with a federated attribute.Roles cover both the built-in roles (admin, user, bot, and so on) and any
custom roles defined in the workspace. Role assignments reflect
workspace-level roles; roles scoped to individual channels (such as owner
or moderator of a single room) sync as role resources for visibility but
do not carry per-channel assignments.
Rocket.Chat’s REST API limits each endpoint to 10 requests per 60
seconds by default. The connector backs off and retries automatically
when it hits the limit, but on workspaces with many users or teams a sync
can take noticeably longer under the default limit. Workspace
administrators can raise the limit under Admin > Settings > Rate
Limiter to speed up syncs.
The token’s account needs administrator access (or at minimum permission
to view users, roles, and all teams — including the view-all-teams
permission). A token created by a regular user cannot list other users or
teams it is not a member of and does not work with this connector.
1
Sign in to your Rocket.Chat workspace as an administrator, or use a
dedicated service account with administrator access.
2
Open your avatar menu and go to My Account > Personal Access
Tokens. If personal access tokens are disabled, a workspace
administrator can enable them under Admin > Settings >
Accounts > Personal Access Tokens.
3
Enter a token name and click Add. Rocket.Chat shows the new
token and the matching user ID once — copy both. The connector
needs the pair: the token is sent as the X-Auth-Token header and
the user ID as the X-User-Id header.
4
Note your workspace’s base URL. For Rocket.Chat Cloud this is
https://<workspace>.rocket.chat; for self-hosted servers it is your
own address, with no trailing slash.