Skip to main content
Version: 0.1

Events API (Alpha)

The Roam Events API (Alpha) delivers real-time notifications to your application via webhooks. Subscribe to events and receive HTTP callbacks when things happen in your Roam workspace.

OpenAPI Spec: webhooks.json

Configuring Webhooks

You can configure webhooks in two ways:

  • Static: In Roam Administration > Developer > API Client, add webhook URLs directly to your app configuration
  • Dynamic: Use the subscription endpoints below to manage webhooks programmatically

Subscription Endpoints

EndpointMethodDescription
/webhook.subscribePOSTCreate or update a webhook subscription
/webhook.unsubscribePOSTRemove a webhook subscription

Available Events

EventDescription
chat:message:dmDirect message received by your app
chat:message:channelChannel message in a group where your app is a member
chat:message:mentionMessage that @mentions your app
chat:message:reactionEmoji reaction added to a message
recording:savedMeeting recording is ready for download
transcript:savedMeeting transcript (Magic Minutes) is available
lobby:bookedNew booking created for a lobby

Webhook Payload Format

All webhooks are delivered as POST requests with JSON payloads. Your endpoint should return a 200 status to acknowledge receipt.

Filtering

Some events support filters to limit notifications:

  • lobby:booked: Filter by lobbyId to receive bookings for specific lobbies only
  • chat:message:reaction: Filter by codes to receive only specific reaction types

Authentication

Authorization: Bearer YOUR_TOKEN

Base URL

https://api.ro.am/v0

This API is in developer preview and is unstable. Contact developer@ro.am with questions.

Contact

Developer Support: developer@ro.am

URL: https://developer.ro.am

Terms of Service

https://ro.am/terms