Find Channel by Name
mattermost.get_channel_by_name
ActionChat & messagingconnection required
Calls the Mattermost API with the connection's credentials.
Look up a channel by its handle and return the channel object, so a later post op has the channel_id Mattermost requires.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Mattermost
- Secret shape
- the personal access token, or {"token": "…"}
- Config it needs
- base_url, team_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 |
|---|---|---|---|---|---|
channel_name The channel handle from its URL, e.g. 'town-square'. | string | Yes | — | — | town-square |
team_id The team to work in. Defaults to the team id set on the connection. | string | No | — | — | — |
include_deleted Also match channels that have been archived. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"channel_name": "town-square",
"include_deleted": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The channel id — what the post ops need. | string | chn123456789 |
team_id The team the channel belongs to. | string | — |
name The channel handle used in its URL. | string | town-square |
display_name The channel name shown in the UI. | string | — |
type 'O' public, 'P' private, 'D' direct, 'G' group. | string | — |
header The channel header text. | string | — |
purpose The channel purpose text. | string | — |
create_at Creation time, in milliseconds since the epoch. | number | — |
{
"create_at": 0,
"display_name": "",
"header": "",
"id": "chn123456789",
"name": "town-square",
"purpose": "",
"team_id": "",
"type": ""
}See Find Channel by Name run in a workflow.
In a technical demo we add the Mattermost connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.