Roam
Enterprise messaging APIs for secure chat, file sharing, and compliance-sensitive collaboration.
Designed for sending messages, sharing files, retrieving conversation history, and reacting when new messages or files arrive.
Example Use Cases
These are the Roam actions Snow can use when building apps with you. Connecting an account does not make Snow run these on its own.
Get 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. Use this action to retrieve details like display name, email, profile image, and other information about a specific chat address. Required scope: chat:read
Tool to get a meeting link. Use when you need to retrieve information about a specific meeting link by its ID. Requires the 'meetinglink:read' scope.
Retrieves the definition of a specific SCIM 2.0 schema by its unique identifier (URN). This endpoint returns the complete schema definition including all attributes, their types, mutability, and other properties. Common schemas include: - urn:ietf:params:scim:schemas:core:2.0:User (User resource schema) - urn:ietf:params:scim:schemas:core:2.0:Group (Group resource schema) - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User (Enterprise User extension) Use this to understand the structure of SCIM resources and what attributes are available.
Post a message to a chat. Messages can be plain markdown text or rich Block Kit layouts with headers, sections, buttons, and more. Messages may be posted to a chat, a group, or addresses such as users or bots. Use syntax <@USER_ID> for mentions.
Sends the given message to the specified recipients. At this time, we only support sending to a single group recipient. You can obtain the group ID on the Group Settings page.
Upload a file to Roam so it can be sent as a chat attachment. Use when you need to upload a file, image, or document to Roam before sending it in a chat message. Returns an item ID that can be used with the chat.post endpoint. Supported file types: - Images (image/png, image/jpeg, image/gif, image/webp): Displayed inline with preview thumbnail - Other files (application/octet-stream): Download link only Maximum file size: 10 MB
Add one or more group members and/or admins to an existing Roam group. Use this tool when: - You need to add new members to an existing group - You need to promote existing members to admin status - You want to bulk add multiple users to a group Access conditions: - For adding members: The group must be public in the user's Roam, or the app must be a member - For adding admins: The app must be an admin of the group Returns empty response on success (HTTP 204).
Add an emoji reaction to a message in a chat. Use this action when you want to react to a message with an emoji in a Roam chat. The action requires the message ID, chat ID, reaction name, and timestamp. Required scope: chat:send_message or chat:write Response codes: 200=success, 400=bad request, 401=invalid credentials, 405=unsupported method, 500=internal error
Create a group address that can be used for chat. Groups which specify an admin will operate in an "Admin only" management mode, where only admins may change settings. Otherwise, all members have that capability. Groups require at least one member or admin.
Tool to create a new group in your Roam organization using SCIM 2.0. Use when you need to provision a new group for managing user access and permissions via the SCIM 2.0 protocol. The displayName is required and must be 64 characters or less.