Overview
This node interacts with Rocket.Chat to manage messages and direct messages (DMs). Specifically, the 'Open DM' operation opens a direct message channel with a specified user by their username. This is useful for initiating private conversations programmatically within Rocket.Chat. For example, it can be used in automation workflows to start a DM with a user before sending messages or notifications.
Use Case Examples
- Opening a DM with a user to start a private conversation.
- Automating customer support by opening DMs with users when a ticket is created.
Properties
| Name | Meaning |
|---|---|
| Username | The username of the user to open a direct message with. This is selected from a list of users loaded dynamically. |
Output
JSON
room_id- The ID of the direct message room opened with the specified user.name- The name of the direct message room.usernames- The usernames of participants in the direct message room.
Dependencies
- Requires an API key credential for Rocket.Chat (rocketChatPat) to authenticate requests.
Troubleshooting
- If the specified username does not exist or is incorrect, the node will fail to open a DM and throw an error.
- If the API key credential is invalid or lacks permissions, the node will not be able to open the DM.
- Ensure the username is selected from the provided list to avoid typos or invalid usernames.
Links
- Rocket.Chat API - im.open - Official Rocket.Chat API documentation for opening direct message channels.