Skip to main content

Use n8n

info

An official Roam n8n node is available. If you have issues accessing or using it, please reach out via Roam Support Chat or email developer@ro.am.

Overview​

This guide shows how to use the official n8n node to:

  • Send a message to a public group
  • Create a meeting link
  • Trigger workflows on new transcripts and new recordings

Prerequisites​

Create an API Key in Roam Administration:

  1. Go to Roam Administration > Developer > API Keys
  2. Create a key and add these scopes:
    • webhook:write
    • chat:send_message
    • recordings:read
    • transcript:read
    • meetinglink:write
    • groups:read

You’ll paste this API Key into n8n when configuring the Roam node credentials.

Actions​

Send Message to Group​

  1. In n8n, add the Roam node and choose the “Send Message to Group” action.
  2. Configure credentials and paste your API Key.
  3. Fill in the fields:
    • Sender Name: The display name for the message sender
    • Sender Image (optional): URL for the sender avatar image
    • Text: Markdown content for the message body
    • Group: Pick the target public group
  4. Test the node to send a message.
info

The Text field accepts Markdown content.

Related reference: Send Message API

  1. Add the Roam node and choose the “Create Meeting Link” action.
  2. Configure credentials and paste your API Key.
  3. Fill in the fields:
    • Name: Meeting name
    • Host Email: Email of the meeting host (must be a member of your Roam)
    • Start/End (optional): RFC3339 timestamps
  4. The node returns the meeting link id and url.

Related reference: Create a meeting link

Triggers​

Add the Roam node in Trigger mode and select one of the following:

  • New Transcript
  • New Recording

Use the trigger output to drive downstream steps (e.g., notifications, storage, or processing).

Related references:

Troubleshooting​

  • Ensure your API Key includes the required scopes listed above.
  • Verify the target group is public for message delivery.
  • Confirm host email is a member of your Roam when creating meeting links.