39 available actions
What your AI agent can do in Roam
Roam HQ provides APIs for secure messaging, chat, file sharing, and collaboration with enterprise-grade security and compliance features. This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 39 actions.
Common starting points
- Get Address InfoGet information about a chat address, which is the name for any entity that may participate in a chat, such as a user, visitor, or bot.
- Get chat historyLists messages in a chat, filtered by date range (after/before).
- Add Reaction to MessageAdd an emoji reaction to a message in a chat.
- Send message to groupSends the given message to the specified recipients.
- Update a meeting linkUpdate settings for an existing meeting link in Roam.
- Patch a groupPartially updates a group using SCIM 2.0 protocol.
Browse all 39 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 20 actions
- Get Address InfoGet information about a chat address, which is the name for any entity that may participate in a chat, such as a user, visitor, or bot.
- Get chat historyLists messages in a chat, filtered by date range (after/before).
- Get meeting linkTool to get a meeting link.
- Get Roam SCIM Resource TypesReturns the list of SCIM 2.0 resource types supported by Roam.
- Get SCIM service provider configTool to retrieve Roam's SCIM service provider configuration.
- Get SCIM schemaRetrieves the definition of a specific SCIM 2.0 schema by its unique identifier (URN).
- Get user by ID (SCIM)Tool to retrieve a single user by their Roam Person ID using SCIM 2.0 protocol.
- Get token infoRetrieves information about the current Roam access token.
- Get user infoGet detailed information about a single user in your Roam workspace.
- List Roam ChatsLists all accessible chats, which consist of all DMs, MultiDMs, and Channels that your bot has been added to, in addition to all public channels.
- List group membersList members in a group in your Roam workspace.
- List SCIM GroupsReturns a paginated list of groups in your Roam organization via SCIM 2.0.
- List Roam LobbiesLists active lobbies in your Roam account.
- List Roam MeetingsLists all meetings in your home Roam, filtered by date range.
- List Roam RecordingsTool to list all recordings in your home Roam.
- List users (SCIM)Tool to list users in your Roam organization using SCIM 2.0 protocol.
- List SCIM SchemasTool to list all SCIM 2.0 schemas supported by Roam.
- List Roam TranscriptsLists all transcripts in your Roam workspace, filtered by date range.
- List User Audit LogTool to get a list of user audit log entries for the account.
- List UsersTool to list all users in the Roam workspace.
Create & communicateCreate records or send supported messagesView 9 actions
- Add group membersAdd one or more group members and/or admins to an existing Roam group.
- Add Reaction to MessageAdd an emoji reaction to a message in a chat.
- Create GroupCreate a group address that can be used for chat.
- Create Roam SCIM GroupTool to create a new group in your Roam organization using SCIM 2.0.
- Create Roam UserCreate a new user in Roam via SCIM 2.0 protocol for automated user provisioning.
- Post message to chatPost a message to a chat.
- Send message to groupSends the given message to the specified recipients.
- Send Typing IndicatorTool to notify other chat participants that you are typing.
- Upload File to RoamUpload a file to Roam so it can be sent as a chat attachment.
Update & manageChange and manage existing recordsView 5 actions
- Patch a groupPartially updates a group using SCIM 2.0 protocol.
- Patch user (SCIM)Partially updates a user using SCIM 2.0 protocol.
- Replace Roam SCIM GroupFully replaces a group's attributes using SCIM 2.0 protocol.
- Replace Roam UserFully replaces (updates) a user's attributes in Roam via SCIM 2.0 protocol.
- Update a meeting linkUpdate settings for an existing meeting link in Roam.
Remove & cancelRemove records or cancel supported workView 3 actions
- Delete Roam GroupArchive a group in Roam using SCIM 2.0 protocol.
- Delete Roam UserArchive a user in Roam using SCIM 2.0 protocol.
- Remove group membersTool to remove one or more members from a group in your Roam workspace.
Other actionsSpecialist and administrative actions.View 2 actions
- Test API ConnectivityTest endpoint for API connectivity.
- Lookup user by emailLook up a user in your Roam workspace by their email address.
Connection record
A connection you can control.
- Sign-in
- OAuth sign-in
- Setup
- Sign in with your own Roam account. Access is limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect Roam
How does the agent connect to Roam?
You sign in with your own Roam account. Permissions are limited to what the agent needs, the connection is health-checked, and you can revoke access from Roam at any time.
What can the agent actually do in Roam?
The page above lists the 39 actions currently available through the Roam connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is Roam included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until Roam is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put Roam to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.