roam · 39 tools · no triggers
Connect it
run auth roam
run auth roam --scope team # shared with the organization
Use it
run roam # common commands
run roam --all # every command
import { roam } from "@boxd/run";
Common tools
| Tool | What it does |
|---|---|
get-address-info | 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. |
get-meeting-link | Tool to get a meeting link. Use when you need to retrieve information about a specific meeting link by its ID. |
get-scim-schema | Retrieves the definition of a specific SCIM 2.0 schema by its unique identifier (URN). |
post-chat | Post a message to a chat. Messages can be plain markdown text or rich Block Kit layouts with headers, sections, buttons, and more. |
send-message | Sends the given message to the specified recipients. At this time, we only support sending to a single group recipient. |
upload-item | Upload a file to Roam so it can be sent as a chat attachment. |
All 39 tools
All 39 tools
| Tool | What it does |
|---|---|
add-group-members | Add one or more group members and/or admins to an existing Roam group. |
add-reaction | 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. |
create-group | 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. |
create-scim-group | Tool to create a new group in your Roam organization using SCIM 2.0. |
create-user | Create a new user in Roam via SCIM 2.0 protocol for automated user provisioning. |
delete-group | Archive a group in Roam using SCIM 2.0 protocol. This is a soft delete operation that archives the group. |
delete-user | Archive a user in Roam using SCIM 2.0 protocol. This is a soft delete operation that deprovisions the user. |
get-address-info | 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. |
get-chat-history | Lists messages in a chat, filtered by date range (after/before). |
get-meeting-link | Tool to get a meeting link. Use when you need to retrieve information about a specific meeting link by its ID. |
get-resource-types | Returns the list of SCIM 2.0 resource types supported by Roam. |
get-scim-config | Tool to retrieve Roam’s SCIM service provider configuration. |
get-scim-schema | Retrieves the definition of a specific SCIM 2.0 schema by its unique identifier (URN). |
get-scim-user | Tool to retrieve a single user by their Roam Person ID using SCIM 2.0 protocol. |
get-test | Test endpoint for API connectivity. Use this endpoint to verify that the Roam API is accessible and authentication is working correctly. |
get-token-info | Retrieves information about the current Roam access token. Use this tool to: - Get the bot’s chat address - Check the OAuth scopes granted to the… |
get-user-info | Get detailed information about a single user in your Roam workspace. |
list-chats | Lists 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-members | List members in a group in your Roam workspace. Use this tool when: - You need to see all members of a specific group - You want to check who has… |
list-groups | Returns a paginated list of groups in your Roam organization via SCIM 2.0. |
list-lobbies | Lists active lobbies in your Roam account. Returns all lobby configurations with their IDs, display names, URLs, and active status. |
list-meetings | Lists all meetings in your home Roam, filtered by date range. |
list-recordings | Tool to list all recordings in your home Roam. Use when you need to retrieve recordings with optional date range filtering (after/before) or pagination. |
list-scim-users | Tool to list users in your Roam organization using SCIM 2.0 protocol. |
list-schemas | Tool to list all SCIM 2.0 schemas supported by Roam. Use when you need to discover available SCIM resource schemas. |
list-transcripts | Lists all transcripts in your Roam workspace, filtered by date range. |
list-user-audit-log | Tool to get a list of user audit log entries for the account. |
list-users | Tool to list all users in the Roam workspace. Use when you need to retrieve a list of users with optional pagination and expanded fields like status. |
lookup-user | Look up a user in your Roam workspace by their email address. |
patch-group | Partially updates a group using SCIM 2.0 protocol. Use this action to add or remove members from a group, or replace the group’s display name. |
patch-user | Partially updates a user using SCIM 2.0 protocol. Use when you need to modify specific attributes of an existing user without replacing the entire resource. |
post-chat | Post a message to a chat. Messages can be plain markdown text or rich Block Kit layouts with headers, sections, buttons, and more. |
remove-group-members | Tool to remove one or more members from a group in your Roam workspace. |
replace-group | Fully replaces a group’s attributes using SCIM 2.0 protocol. |
replace-user | Fully replaces (updates) a user’s attributes in Roam via SCIM 2.0 protocol. |
send-message | Sends the given message to the specified recipients. At this time, we only support sending to a single group recipient. |
send-typing | Tool to notify other chat participants that you are typing. Use when you want to show a typing indicator to one or more users in a chat conversation. |
update-meeting-link | Update settings for an existing meeting link in Roam. Use this action when you need to modify the name, start time, or end time of an existing meeting link. |
upload-item | Upload a file to Roam so it can be sent as a chat attachment. |