Skip to main content

Roam HQ Developer Docs

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

APIs

Roam HQ API

v1

Core API for messaging, recordings, and compliance exports.

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

On-Air API

v1

Create events, manage guest lists, track RSVPs, and monitor attendance for On-Air events.

/onair.event.create/onair.guest.add/onair.guest.list/onair.attendance.list
api.ro.am/v1

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

Events API

Alpha

Real-time webhooks for messages, recordings, transcripts, lobby bookings, and On-Air events.

/webhook.subscribechat:message:dmonair.event.createdonair.guest.rsvp
api.ro.am/v0

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

Common Use Cases

Roam supports Organization access for workspace-wide integrations and Personal access for personal AI tools and automations.

Organization Access

Build bots and automations that operate across your workspace with their own app identity.

Build a Chat Bot

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

Send Notifications

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

Compliance & Archival

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

User Provisioning

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

On-Air Event Management

Create events, manage guest lists, and track RSVPs programmatically. Sync with external event platforms or build custom registration flows.

Personal Access

Connect personal AI assistants and automations that act as you and see only your data.

AI Meeting Assistant

Connect Claude or ChatGPT to search your meetings, get AI-generated summaries, and review action items.

Post-Meeting Productivity

Receive your meeting transcripts and action items automatically for personal follow-up and task tracking.

Personal Message Management

Search and manage your Roam messages through AI assistants. Send messages as yourself.

Scheduling Integrations

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

Getting Started

Roam supports two access models: Organization access for workspace-wide bots and automations, and Personal access for personal AI assistants. Use API Keys for server-to-server Organization access, or OAuth for apps supporting either model.

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