Invite Users to Channel
slack.invite_to_channel
ActionChat & messagingconnection required
Calls the Slack Web API with the connection's bot token.
Add one or more users to a channel by user id.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Slack
- Secret shape
- the Slack bot token (xoxb-…), or {"token": "xoxb-…"}
- 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 Channel id to act on (C…, G… or D…). Supports {{ }}. | string | Yes | — | — | — |
users Comma-separated user ids to invite (U…), up to 1000. | string | Yes | — | — | — |
force Invite the valid ids and ignore the invalid ones instead of failing. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"force": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok Always true; a failure raises instead. | boolean | true |
channel The channel id that was acted on. | string | — |
invited The user ids this step asked Slack to invite. | array | — |
count How many user ids were invited. | number | — |
{
"channel": "",
"count": 0,
"invited": [],
"ok": true
}Notes
- The bot must be a member of a private channel before it can act there (Slack answers not_in_channel otherwise).
- Slack rate-limits each Web API method on its own tier; a throttled call fails with the number of seconds to wait and is safe for the node's retry policy to repeat.
Templates that use Slack
See Invite Users to Channel run in a workflow.
In a technical demo we add the Slack connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.