Add Channel Member
mattermost.add_channel_member
ActionChat & messagingconnection required
Calls the Mattermost API with the connection's credentials.
Add a user to a channel.
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, 2 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_id The channel id (not its name) — use mattermost.get_channel_by_name to resolve one. | string | Yes | — | — | — |
user_id The user to add — from mattermost.get_user_by_username or by_email. | string | Yes | — | — | — |
post_root_id Thread root to post the join message into; usually left blank. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
channel_id The channel that was joined. | string | — |
user_id The user that was added. | string | — |
roles The member's channel roles. | string | — |
{
"channel_id": "",
"roles": "",
"user_id": ""
}See Add Channel Member 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.