Skip to main content

Roam HQ Developer Docs

Build integrations with Roam HQ, your team's virtual office. Post messages, retrieve transcripts, manage users, and subscribe to real-time events.

Get Startedllms.txt

Pre-built Integrations

Get started quickly with these no-code and low-code integrations.

Zapier

Connect Roam to 5,000+ apps with no-code automation

n8n

Self-hosted workflow automation for Roam events

GitHub Actions

Post workflow notifications to Roam channels

Webhooks + Datadog

Forward Roam events to monitoring dashboards

Lobby Embed

Embed your Roam lobby on any webpage

GitHub on the Map

Show GitHub activity indicators on the Roam map

APIs

Roam HQ API

v1

Core API for sending messages to groups, listing recordings, and exporting message archives for compliance.

/chat.sendMessage/groups.list/recording.list/messageevent.export
api.ro.am/v1
OpenAPIDocs →

Chat API

Alpha

Advanced chat, meeting, and transcript APIs. Build bots, retrieve message history, manage groups, and access meeting transcripts.

/chat.post/chat.history/transcript.info/group.create/user.list
api.ro.am/v0
OpenAPIDocs →

Events API

Alpha

Real-time webhooks for messages, reactions, recordings, transcripts, and lobby bookings.

/webhook.subscribechat:message:dmtranscript:savedlobby:booked
api.ro.am/v0
OpenAPIDocs →

SCIM 2.0 API

Automated user provisioning and deprovisioning. Connect Okta, Azure AD, or other identity providers for seamless user sync.

/Users/Groups/ServiceProviderConfig
api.ro.am/scim/v2
OpenAPIDocs →

Common Use Cases

Build a Chat Bot

Create an OAuth app to receive messages via webhooks and respond programmatically. Show typing indicators and add reactions.

chat:message events/chat.post/chat.typing

Post-Meeting Automation

Get notified when recordings and transcripts are ready. Extract summaries, action items, and full transcripts for processing.

transcript:savedrecording:saved/transcript.info

Send Notifications

Post alerts from CI/CD, monitoring, or ticketing systems directly into Roam groups.

/chat.sendMessage/groups.list

Compliance & Archival

Export daily message archives for compliance, legal holds, or data warehousing.

/messageevent.export/recording.list

User Provisioning

Automatically sync users from Okta, Azure AD, or other identity providers using SCIM 2.0.

SCIM UsersSCIM Groups

Scheduling Integrations

Create meeting links programmatically and sync lobby bookings with external calendars.

/meetinglink.createlobby:booked

Getting Started

Create an API client in Roam Administration > Developer to get your credentials. Choose between API Keys for server-to-server integrations or OAuth for user-authorized apps.

Quick Start Guide
Authentication
curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.ro.am/v1/groups.list