Get Pinned Messages
rocketchat.get_pinned_messages
ActionChat & messagingconnection required
Calls the Rocket.Chat API with the connection's credentials.
List the messages pinned in a room.
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
3 fields, 1 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 room id (not its name) — use rocketchat.get_channel_info to resolve one. | string | Yes | — | — | — |
count How many messages to return. Rocket.Chat caps this at the workspace's API_Upper_Count_Limit setting. | number | No | 50 | ≥ 1 | — |
offset How many messages to skip before this page. | number | No | 0 | ≥ 0 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"count": 50,
"offset": 0
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
messages The matching messages, as Rocket.Chat returned them. | array | — |
count How many messages this page carries. | number | — |
offset The offset this page started at, when the endpoint reports one. | number | — |
total Total matches, when the endpoint reports one. | number | — |
{
"count": 0,
"messages": [],
"offset": 0,
"total": 0
}See Get Pinned Messages 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.