Get Channel Info
rocketchat.get_channel_info
ActionChat & messagingconnection required
Calls the Rocket.Chat API with the connection's credentials.
Resolve a channel to its room object. This is how a channel name becomes the room id the other message ops need.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Rocket.Chat
- Secret shape
- the personal access token, or {"token": "…", "user_id": "…"}
- Config it needs
- base_url, user_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
room_id The channel's room id. Give this or a room_name. | string | No | — | — | — |
room_name The channel's name, without the leading '#'. Give this or a room_id. | string | No | — | — | general |
- At least one of room_id, room_name must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"room_name": "general"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
channel._id The room id the message ops need. | string | — |
channel.name The channel's name. | string | general |
channel.t The room type; 'c' for a public channel. | string | — |
channel.msgs How many messages the channel holds. | number | — |
channel.usersCount How many members the channel has. | number | — |
success True — Rocket.Chat's own envelope flag. | boolean | — |
{
"channel": {
"_id": "",
"msgs": 0,
"name": "general",
"t": "",
"usersCount": 0
},
"success": false
}Notes
- Resolves a public channel (Rocket.Chat's channels.* surface). A private group or a direct message is not covered by this endpoint.
See Get Channel Info run in a workflow.
In a technical demo we add the Rocket.Chat connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.