APIs for developers

Roam provides APIs, webhooks, developer tools, and ready-made integrations for connecting your virtual office with other software. Use the Roam Developer Documentation to create an application, choose an authentication method, and find detailed guides and endpoint reference material.

Get Started

Create and manage applications in Settings > Roam Administration > Developer. Roam supports API keys for server-to-server integrations, OAuth for applications installed by an organization or individual, and Personal Access Tokens when permitted by workspace policy.

Before building, review the documentation for authentication and OAuth, access models, and permission scopes. Official TypeScript, Go, and Python SDKs are also available.

Roam API

The Roam API is the main API for building custom integrations. It includes APIs to:

• Read, search, send, schedule, update, and react to chat messages
• Create and manage groups and group membership
• List users, look up user information, and show custom activity on the map
• Access meetings, participants, transcripts, summaries, action items, and recordings
• Create and manage meeting links and calendar events
• Access Magicasts, lobbies, lobby bookings, guest badges, audit logs, and compliance exports

The API reference documents every endpoint, request and response format, pagination, rate limits, errors, and API versioning.

Webhooks

Use the Webhooks API to receive real-time notifications when activity occurs in Roam. Applications can subscribe to chat messages and reactions, meeting and Magicast activity, lobby bookings, user status changes, On-Air updates, and application or token lifecycle events.

Webhooks can be configured in Roam Administration or managed programmatically. The documentation covers subscriptions, event payloads, filtering, signature verification, retries, and failed-delivery debugging.

On-Air API

The On-Air API lets you create and manage On-Air events, guest lists, RSVPs, and attendance data. Use it to build custom registration flows, synchronize an external events platform, automate guest management, or report on attendance.

SCIM 2.0 API

The SCIM 2.0 API supports automated user and group provisioning from identity providers such as Okta and Microsoft Entra ID. It can create, update, deactivate, and synchronize people and groups in Roam using the standard SCIM protocol.

Apps, Bots, and AI Assistants

Use Roam’s guides to build a notification bot, an interactive bot, or an AI agent. Apps can send rich messages using Block Kit, add app actions and slash commands, and create rich previews when people share links.

Roam’s Model Context Protocol (MCP) integration connects Roam meetings, transcripts, chat, people, calendars, and other supported data with compatible AI assistants. This lets an assistant search Roam, summarize work, prepare briefs, answer questions about meetings and conversations, and take permitted actions such as sending messages.

See Integrate Roam with AI assistants for a user-facing overview and setup options.

Automation and Ready-Made Integrations

You do not always need to build a custom application. Roam also provides:

• Webhook Relays to turn incoming webhooks from external services into formatted Roam messages without writing code
• Zapier and n8n for connecting Roam with automated workflows
• GitHub Actions for posting workflow and deployment updates to Roam
• OpenClaw for using Roam as an AI agent’s data source, chat surface, or both

Lobby Integrations

Use Lobby Booking for AI Agents to let an assistant find available times and book meetings through a public Roam Lobby. You can also embed a Lobby into your website for booking and drop-in experiences; see the Lobby Embed developer guide for implementation details.

For endpoint details, examples, and the latest capabilities, visit the Roam Developer Documentation.