docs: improve Slack setup guide with channel event subscriptions and scopes

The #1 support issue with Slack is 'bot works in DMs but not channels'.
This is almost always caused by missing event subscriptions (message.channels,
message.groups) or missing OAuth scopes (channels:history, groups:history).

Changes:
- slack.md: Move channels:history and groups:history from optional to required
  scopes. Move message.channels and message.groups to required events. Add new
  'How the Bot Responds' section explaining DM vs channel behavior. Add Step 8
  for inviting bot to channels. Expand troubleshooting table with specific
  'works in DMs not channels' entry. Add quick checklist for channel debugging.
- setup.py: Expand Slack setup wizard with all required scopes, event
  subscriptions, and a warning that without message.channels/message.groups
  the bot only works in DMs. Add link to full docs. Improve Member ID
  discovery instructions.
- config.py: Update SLACK_BOT_TOKEN and SLACK_APP_TOKEN descriptions to list
  required scopes and event subscriptions inline.
This commit is contained in:
teknium1 2026-03-09 14:00:11 -07:00
parent a5a5d82a21
commit ac58309dbd
3 changed files with 95 additions and 24 deletions

View file

@ -401,14 +401,18 @@ OPTIONAL_ENV_VARS = {
"category": "messaging", "category": "messaging",
}, },
"SLACK_BOT_TOKEN": { "SLACK_BOT_TOKEN": {
"description": "Slack bot integration", "description": "Slack bot token (xoxb-). Get from OAuth & Permissions after installing your app. "
"Required scopes: chat:write, app_mentions:read, channels:history, groups:history, "
"im:history, im:read, im:write, users:read, files:write",
"prompt": "Slack Bot Token (xoxb-...)", "prompt": "Slack Bot Token (xoxb-...)",
"url": "https://api.slack.com/apps", "url": "https://api.slack.com/apps",
"password": True, "password": True,
"category": "messaging", "category": "messaging",
}, },
"SLACK_APP_TOKEN": { "SLACK_APP_TOKEN": {
"description": "Slack Socket Mode connection", "description": "Slack app-level token (xapp-) for Socket Mode. Get from Basic Information → "
"App-Level Tokens. Also ensure Event Subscriptions include: message.im, "
"message.channels, message.groups, app_mention",
"prompt": "Slack App Token (xapp-...)", "prompt": "Slack App Token (xapp-...)",
"url": "https://api.slack.com/apps", "url": "https://api.slack.com/apps",
"password": True, "password": True,

View file

@ -1572,10 +1572,22 @@ def setup_gateway(config: dict):
if not existing_slack and prompt_yes_no("Set up Slack bot?", False): if not existing_slack and prompt_yes_no("Set up Slack bot?", False):
print_info("Steps to create a Slack app:") print_info("Steps to create a Slack app:")
print_info(" 1. Go to https://api.slack.com/apps → Create New App") print_info(" 1. Go to https://api.slack.com/apps → Create New App (from scratch)")
print_info(" 2. Enable Socket Mode: App Settings → Socket Mode → Enable") print_info(" 2. Enable Socket Mode: Settings → Socket Mode → Enable")
print_info(" 3. Bot Token: OAuth & Permissions → Install to Workspace") print_info(" • Create an App-Level Token with 'connections:write' scope")
print_info(" 4. App Token: Basic Information → App-Level Tokens → Generate") print_info(" 3. Add Bot Token Scopes: Features → OAuth & Permissions")
print_info(" Required scopes: chat:write, app_mentions:read,")
print_info(" channels:history, channels:read, groups:history,")
print_info(" im:history, im:read, im:write, users:read, files:write")
print_info(" 4. Subscribe to Events: Features → Event Subscriptions → Enable")
print_info(" Required events: message.im, message.channels,")
print_info(" message.groups, app_mention")
print_warning(" ⚠ Without message.channels/message.groups events,")
print_warning(" the bot will ONLY work in DMs, not channels!")
print_info(" 5. Install to Workspace: Settings → Install App")
print_info(" 6. After installing, invite the bot to channels: /invite @YourBot")
print()
print_info(" Full guide: https://hermes-agent.ai/docs/user-guide/messaging/slack")
print() print()
bot_token = prompt("Slack Bot Token (xoxb-...)", password=True) bot_token = prompt("Slack Bot Token (xoxb-...)", password=True)
if bot_token: if bot_token:
@ -1587,7 +1599,7 @@ def setup_gateway(config: dict):
print() print()
print_info("🔒 Security: Restrict who can use your bot") print_info("🔒 Security: Restrict who can use your bot")
print_info(" Find Slack user IDs in your profile or via the Slack API") print_info(" To find a Member ID: click a user's name → View full profile → ⋮ → Copy member ID")
print() print()
allowed_users = prompt("Allowed user IDs (comma-separated, leave empty for open access)") allowed_users = prompt("Allowed user IDs (comma-separated, leave empty for open access)")
if allowed_users: if allowed_users:

View file

@ -46,20 +46,26 @@ Navigate to **Features → OAuth & Permissions** in the sidebar. Scroll to **Sco
| Scope | Purpose | | Scope | Purpose |
|-------|---------| |-------|---------|
| `chat:write` | Send messages as the bot | | `chat:write` | Send messages as the bot |
| `app_mentions:read` | Respond when @mentioned in channels | | `app_mentions:read` | Detect when @mentioned in channels |
| `channels:history` | Read messages in public channels the bot is in | | `channels:history` | Read messages in public channels the bot is in |
| `channels:read` | List and get info about public channels | | `channels:read` | List and get info about public channels |
| `groups:history` | Read messages in private channels the bot is invited to |
| `im:history` | Read direct message history | | `im:history` | Read direct message history |
| `im:read` | View basic DM info | | `im:read` | View basic DM info |
| `im:write` | Open and manage DMs | | `im:write` | Open and manage DMs |
| `users:read` | Look up user information | | `users:read` | Look up user information |
| `files:write` | Upload files (images, audio, documents) |
:::caution Missing scopes = missing features
Without `channels:history` and `groups:history`, the bot **will not receive messages in channels**
it will only work in DMs. These are the most commonly missed scopes.
:::
**Optional scopes:** **Optional scopes:**
| Scope | Purpose | | Scope | Purpose |
|-------|---------| |-------|---------|
| `groups:history` | Read messages in private channels the bot is invited to | | `groups:read` | List and get info about private channels |
| `files:write` | Upload files (audio, images) |
--- ---
@ -83,23 +89,27 @@ You can always find or regenerate app-level tokens under **Settings → Basic In
## Step 4: Subscribe to Events ## Step 4: Subscribe to Events
This step is critical — it controls what messages the bot can see.
1. In the sidebar, go to **Features → Event Subscriptions** 1. In the sidebar, go to **Features → Event Subscriptions**
2. Toggle **Enable Events** to ON 2. Toggle **Enable Events** to ON
3. Expand **Subscribe to bot events** and add: 3. Expand **Subscribe to bot events** and add:
| Event | Purpose | | Event | Required? | Purpose |
|-------|---------| |-------|-----------|---------|
| `app_mention` | Bot responds when @mentioned in any channel | | `message.im` | **Yes** | Bot receives direct messages |
| `message.im` | Bot responds to direct messages | | `message.channels` | **Yes** | Bot receives messages in **public** channels it's added to |
| `message.groups` | **Recommended** | Bot receives messages in **private** channels it's invited to |
**Optional event:** | `app_mention` | **Yes** | Prevents Bolt SDK errors when bot is @mentioned |
| Event | Purpose |
|-------|---------|
| `message.channels` | Bot sees all messages in public channels it's added to |
4. Click **Save Changes** at the bottom of the page 4. Click **Save Changes** at the bottom of the page
:::danger Missing event subscriptions is the #1 setup issue
If the bot works in DMs but **not in channels**, you almost certainly forgot to add
`message.channels` (for public channels) and/or `message.groups` (for private channels).
Without these events, Slack simply never delivers channel messages to the bot.
:::
--- ---
## Step 5: Install App to Workspace ## Step 5: Install App to Workspace
@ -111,8 +121,8 @@ You can always find or regenerate app-level tokens under **Settings → Basic In
5. **Copy this token** — this is your `SLACK_BOT_TOKEN` 5. **Copy this token** — this is your `SLACK_BOT_TOKEN`
:::tip :::tip
If you change scopes later, you'll need to **reinstall the app** for the new scopes to take effect. If you change scopes or event subscriptions later, you **must reinstall the app** for the changes
The Install App page will show a banner prompting you to do so. to take effect. The Install App page will show a banner prompting you to do so.
::: :::
--- ---
@ -139,7 +149,7 @@ Add the following to your `~/.hermes/.env` file:
```bash ```bash
# Required # Required
SLACK_BOT_TOKEN=xoxb-your-bot-token-here SLACK_BOT_TOKEN=xoxb-your-bot-token-here
SLACK_APP_TOKEN=xapp-your-app-level-token-here SLACK_APP_TOKEN=xapp-your-app-token-here
SLACK_ALLOWED_USERS=U01ABC2DEF3 # Comma-separated Member IDs SLACK_ALLOWED_USERS=U01ABC2DEF3 # Comma-separated Member IDs
# Optional # Optional
@ -161,6 +171,35 @@ hermes gateway install # Install as a system service
--- ---
## Step 8: Invite the Bot to Channels
After starting the gateway, you need to **invite the bot** to any channel where you want it to respond:
```
/invite @Hermes Agent
```
The bot will **not** automatically join channels. You must invite it to each channel individually.
---
## How the Bot Responds
Understanding how Hermes behaves in different contexts:
| Context | Behavior |
|---------|----------|
| **DMs** | Bot responds to every message — no @mention needed |
| **Channels** | Bot **only responds when @mentioned** (e.g., `@Hermes Agent what time is it?`) |
| **Threads** | Bot replies in threads when the triggering message is in a thread |
:::tip
In channels, always @mention the bot. Simply typing a message without mentioning it will be ignored.
This is intentional — it prevents the bot from responding to every message in busy channels.
:::
---
## Home Channel ## Home Channel
Set `SLACK_HOME_CHANNEL` to a channel ID where Hermes will deliver scheduled messages, Set `SLACK_HOME_CHANNEL` to a channel ID where Hermes will deliver scheduled messages,
@ -192,11 +231,27 @@ Hermes supports voice on Slack:
| Problem | Solution | | Problem | Solution |
|---------|----------| |---------|----------|
| Bot doesn't respond to DMs | Verify `message.im` is in your event subscriptions and the app is reinstalled | | Bot doesn't respond to DMs | Verify `message.im` is in your event subscriptions and the app is reinstalled |
| Bot doesn't respond to @mentions | Verify `app_mention` is in your event subscriptions | | Bot works in DMs but not in channels | **Most common issue.** Add `message.channels` and `message.groups` to event subscriptions, reinstall the app, and invite the bot to the channel with `/invite @Hermes Agent` |
| Bot doesn't respond to @mentions in channels | 1) Check `message.channels` event is subscribed. 2) Bot must be invited to the channel. 3) Ensure `channels:history` scope is added. 4) Reinstall the app after scope/event changes |
| Bot ignores messages in private channels | Add both the `message.groups` event subscription and `groups:history` scope, then reinstall the app and `/invite` the bot |
| "not_authed" or "invalid_auth" errors | Regenerate your Bot Token and App Token, update `.env` | | "not_authed" or "invalid_auth" errors | Regenerate your Bot Token and App Token, update `.env` |
| Bot responds but can't post in a channel | Invite the bot to the channel with `/invite @Hermes Agent` | | Bot responds but can't post in a channel | Invite the bot to the channel with `/invite @Hermes Agent` |
| "missing_scope" error | Add the required scope in OAuth & Permissions, then **reinstall** the app | | "missing_scope" error | Add the required scope in OAuth & Permissions, then **reinstall** the app |
| Socket disconnects frequently | Check your network; Bolt auto-reconnects but unstable connections cause lag | | Socket disconnects frequently | Check your network; Bolt auto-reconnects but unstable connections cause lag |
| Changed scopes/events but nothing changed | You **must reinstall** the app to your workspace after any scope or event subscription change |
### Quick Checklist
If the bot isn't working in channels, verify **all** of the following:
1. ✅ `message.channels` event is subscribed (for public channels)
2. ✅ `message.groups` event is subscribed (for private channels)
3. ✅ `app_mention` event is subscribed
4. ✅ `channels:history` scope is added (for public channels)
5. ✅ `groups:history` scope is added (for private channels)
6. ✅ App was **reinstalled** after adding scopes/events
7. ✅ Bot was **invited** to the channel (`/invite @Hermes Agent`)
8. ✅ You are **@mentioning** the bot in your message
--- ---