Pin Message
rocketchat.pin_message
ActionChat & messagingconnection required
Calls the Rocket.Chat API with the connection's credentials.
Pin a message so it shows in the room's pinned list.
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
1 field, 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 |
|---|---|---|---|---|---|
message_id The id of the message to act on. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
message_id The message the mark was applied to. | string | — |
message The message object, when Rocket.Chat echoed one back. | object | — |
pinned True — the message is now pinned. | boolean | — |
{
"message": {},
"message_id": "",
"pinned": false
}See Pin Message 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.