Roam icon

Roam

Interact with Roam

Actions2

Overview

This node allows sending chat messages to a specified group within the Roam platform. It is useful for automating communication workflows, such as notifying team members about updates, alerts, or any other information directly into a group chat. For example, you can use this node to send a message when a new task is created in your project management tool or to broadcast system status updates.

Properties

Name Meaning
Text The content of the message to be sent. This is a required string input where you write the message text.
Bot Name The display name of the bot sending the message. Defaults to "n8n".
Sender Image URL URL of an image to represent the sender (bot) in the chat message. Optional.
Group Name or ID The target group to which the message will be sent. You can select from a list of groups or specify an ID using an expression. This is required.

Output

The node outputs an array of JSON objects representing the results of sending messages. Each object corresponds to one input item processed and contains the response data from the Roam API related to the sent message. If the operation fails and the node is configured to continue on failure, the output includes an error field describing the issue.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Roam platform.
  • The node uses the Roam API endpoint /v1/groups.list to load available groups dynamically.
  • Proper configuration of the API authentication credentials in n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying an incorrect or non-existent group ID will result in errors when sending messages.
    • Network connectivity problems may prevent API requests from completing.

  • Error messages:

    • Authentication errors typically indicate invalid or expired credentials; reconfigure the API key.
    • "Group not found" errors suggest the provided group ID does not exist or is inaccessible; verify the group selection.
    • API request failures due to rate limits or server errors should be retried after some time.

Links and References

Discussion