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
| Endpoint | Method | Description |
|---|---|---|
/webhook.subscribe | POST | Create or update a webhook subscription |
/webhook.unsubscribe | POST | Remove a webhook subscription |
Available Events
| Event | Description |
|---|---|
chat:message:dm | Direct message received by your app |
chat:message:channel | Channel message in a group where your app is a member |
chat:message:mention | Message that @mentions your app |
chat:message:reaction | Emoji reaction added to a message |
recording:saved | Meeting recording is ready for download |
transcript:saved | Meeting transcript (Magic Minutes) is available |
lobby:booked | New 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 bylobbyIdto receive bookings for specific lobbies onlychat:message:reaction: Filter bycodesto 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.
Terms of Service
https://ro.am/terms