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

Quickstarts

Pick the guide that matches what you're building — each one gets you a working integration in about ten minutes.

Interactive bot

Receive messages over webhooks and reply, react, or show a typing indicator

AI agent / MCP

Give an assistant access to your meetings, transcripts, and chat

Pre-built Integrations

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

OpenClaw

Give your OpenClaw AI agent access to meetings, transcripts, and chat

Hermes

Run a Hermes AI agent directly inside Roam chat as a personal or org bot

MCP Server

Connect Claude and other AI assistants to your Roam data

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

SDKs

Official client libraries, generated from the same OpenAPI spec as the API reference. Cursor pagination, retries, and typed errors are handled for you.

TypeScript

Available

Typed client for Node.js and the browser, with no runtime dependencies.

@roamhq/sdk

Go

Available

Idiomatic client with typed errors and context support.

ro.am/roamhq

Python

Available

Typed client with sync and async support.

roamhq
npm install @roamhq/sdkgo get ro.am/roamhqpip install roamhqRead the SDK guide →

APIs

Roam API

Chat, meetings, users, and groups. Build bots, send messages, retrieve transcripts, manage groups, and react to messages.

/chat.post/meeting.info/user.list/group.create/reaction.add
api.ro.am/v1
OpenAPIDocs →

Webhooks API

Real-time webhooks for chat, meetings, lobbies, and app lifecycle events.

/webhook.subscribechat.messagemeeting.ended
api.ro.am/v1
OpenAPIDocs →

On-Air API

Create external On-Air events, manage guest lists, and track RSVPs programmatically.

/onair.event.create/onair.guest.add/onair.guest.list
api.ro.am/v1
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

Endpoint-level starting points for the scenarios without a quickstart guide.

Post-Meeting Automation

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

meeting.ended/meeting.transcript/meeting.info

Compliance & Audit

Review user audit logs and meeting records for compliance, legal holds, or operational review.

/userauditlog.list/messageevent.export/meeting.list

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/group.list