Post to Roam chats and groups, create meeting links and read meetings, transcripts and folders.
Explore 65 workflow actions for Roam, including account permissions and operation limits.
30 read actions35 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Access token info
Read
Get information about the access token, including the authenticated user/bot and granted scopes.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Add group members
Write
Add one or more group members with specified roles.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add reaction to message
Write
Add a reaction to a message in a chat.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Append to a streaming message
Write
Append a chunk of text to an open stream (see `/chat.startStream`).
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Archive a group
Write
Archive a group by ID.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Cancel a scheduled message
Write
Cancels a pending message scheduled via `/chat.post`'s sendAt, so it will never be delivered.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Clear a user's external activity
Write
End an activity previously created with `user.activity.set`.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Clear a user's status bubble
Write
Clears the shared thought bubble, including a bubble written by the UI or another integration.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Clear a user's Will Return / Out of Roam
Write
Remove the Will Return / Out of Roam previously written with `user.status.set` or the desktop client.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a calendar event
Write
Create a calendar event on the host's connected calendar.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a chat message link
Write
Create a shareable Roam link to a specific chat message.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a folder
Write
Create a folder for meetings and Magicasts.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a group
Write
Create a group chat.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create a meeting link
Write
Create a meeting link.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a folder
Write
Delete a folder.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete a message
Write
Delete a previously posted bot message.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
File meetings and Magicasts into a folder
Write
File up to 100 meetings and Magicasts into a folder in one call.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get a meeting link
Read
Get a meeting link.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Get a user's status bubble
Read
Returns the shared UI/API thought bubble, or null when no live bubble exists.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Get chat messages
Read
List messages in a chat, filtered by date range (after/before).
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Get folder info
Read
Get one folder by ID: name, item count, creation time, and , for Personal access , the caller's role.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Get group info
Read
Get information about a specific group by its ID or name.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Get magicast info
Read
Get a Magicast by ID with its transcript cues, chapters and video status (signed video and player links are left out).
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Get meeting info
Read
Get detailed information about a specific meeting, including AI-generated summary, action items, and chapters.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Get meeting transcript
Read
Retrieve the transcript for a meeting.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Get user info
Read
Resolve a v1 principal by ID, or look up a workspace member by email.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Join a group
Write
Join a public group as the calling identity (Slack conversations.join).
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
List a user's external activities
Read
Return every currently live external activity for a user , every integration's rows, not only yours.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List calendar events
Read
List events from the authenticated user's connected calendars within a date range.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List chats
Read
List accessible chats , DMs, multi-DMs, group chats, all-hands "team Roam" groups, and meeting chats.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List conversations
Read
Lists conversations (meetings) that occurred in your Roam, with participant details.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List folder contents
Read
List the meetings and Magicasts filed in a folder, newest first, with each item's metadata.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List folder members
Read
List everyone who belongs to a folder and their role (admin or viewer).
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List folders
Read
List folders of meetings and Magicasts, newest first.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List group members
Read
List members in a group with their roles.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List groups
Read
Lists non-archived groups accessible to the caller.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List lobbies
Read
Lists active lobbies in your account.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List lobby bookings
Read
Lists bookings for a specific lobby configuration, filtered by date range (after/before).
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List magicasts
Read
List Magicasts in your account.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List meeting participants
Read
Paginate through all participants of a meeting.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List meetings
Read
List meetings, ordered newest-first.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List reactions on a message
Read
List reactions on a specific message, grouped by emoji (Slack-style {name, count, users}).
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List scheduled messages
Read
Lists pending messages scheduled via `/chat.post`'s sendAt that have not been sent yet.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
List users
Read
List workspace members, or hydrate an explicit ordered set of principal IDs.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Post an ephemeral message
Write
Post an ephemeral message , visible to a single member of a chat, with an "Only you can see this" header , without posting anything the other members can see.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Post story
Write
Posts a story to your Roam.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove folder members
Write
Remove up to 100 people from a folder.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove group members
Write
Remove one or more group members.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove meetings and Magicasts from a folder
Write
Remove up to 100 meetings and Magicasts from a folder in one call.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove reaction from message
Write
Remove a reaction from a message in a chat.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Rename a folder
Write
Rename a folder by ID.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Rename a group
Write
Rename a group by ID.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Resolve a chat link
Read
Parse a Roam chat deep link (e.g.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Search chat messages
Read
Full-text search over the caller's accessible messages.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
Send a message
Write
Send a message to a chat.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Send a typing indicator
Write
Notify other chat participants that you are working on a response.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set a user's external activity
Write
Paint a badge (and optional glow) on a user's seat for work happening outside Roam , a phone call, a browser meeting, a CRM session.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set a user's status bubble
Write
Replaces the shared UI/API thought bubble.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Set a user's Will Return / Out of Roam
Write
Record an absence on a workspace member , the same Will Return Today / Out of Roam field the desktop client writes, already readable via `user.info?expand=status` and `user.status.update`.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Start a streaming message
Write
Open a streaming message and post its first content.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Stop a streaming message
Write
Finalize an open stream (see `/chat.startStream`) into a single persisted chat message and return its timestamp.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Unfurl a link
Write
Attach app-provided preview cards to links in an existing text message.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a meeting link
Write
Update a meeting link.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update a message
Write
Edit a previously posted bot message.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
A repeated request may repeat the external action. Review the previous result before retrying a write.
User Audit Log
Read
Get a list of user audit log entries for the account.
Permissions and limits
Account permissions
A Roam API key (Roam Administration, Developer) or personal access token (User Settings, Developer) with the scopes each call names
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Roam. A saved workflow is not a completed provider action.
Communication ยท CONNECTION
