Slack
适用范围
本页面适用于以下场景:
- 设置 Slack 或调试 Slack socket/HTTP 模式
Socket 模式(默认)
快速设置(初学者)
- 创建一个 Slack 应用并启用 Socket Mode。
- 创建一个 App Token(
xapp-...)和 Bot Token(xoxb-...)。 - 为 Clawdbot 设置 tokens 并启动网关。
最小配置:
{
channels: {
slack: {
enabled: true,
appToken: "xapp-...",
botToken: "xoxb-..."
}
}
}设置步骤
- 在 https://api.slack.com/apps 创建一个 Slack 应用(From scratch)。
- Socket Mode → 切换为开启。然后进入 Basic Information → App-Level Tokens → Generate Token and Scopes,设置 scope 为
connections:write。复制 App Token(xapp-...)。 - OAuth & Permissions → 添加 bot token scopes(使用下面的清单)。点击 Install to Workspace。复制 Bot User OAuth Token(
xoxb-...)。 - 可选:OAuth & Permissions → 添加 User Token Scopes(参见下面的只读列表)。重新安装应用并复制 User OAuth Token(
xoxp-...)。 - Event Subscriptions → 启用事件并订阅:
message.*(包括编辑/删除/线程广播)app_mentionreaction_added、reaction_removedmember_joined_channel、member_left_channelchannel_renamepin_added、pin_removed
- 将 bot 邀请到你希望它读取的频道。
- Slash Commands → 如果你使用
channels.slack.slashCommand,创建/clawd。如果启用原生命令,为每个内置命令添加一个斜杠命令(名称与/help相同)。除非你设置channels.slack.commands.native: true,否则 Slack 的原生命令默认关闭(全局commands.native为"auto",这会让 Slack 保持关闭)。 - App Home → 启用 Messages Tab,以便用户可以向 bot 发送私信。
使用下面的清单,确保 scopes 和事件保持同步。
多账户支持:使用 channels.slack.accounts 配置每个账户的 tokens 和可选的 name。参见 gateway/configuration 了解共享模式。
Clawdbot 配置(最小)
通过环境变量设置 tokens(推荐):
SLACK_APP_TOKEN=xapp-...SLACK_BOT_TOKEN=xoxb-...
或通过配置:
{
channels: {
slack: {
enabled: true,
appToken: "xapp-...",
botToken: "xoxb-..."
}
}
}用户 token(可选)
Clawdbot 可以使用 Slack 用户 token(xoxp-...)进行读取操作(历史记录、固定消息、反应、表情符号、成员信息)。默认情况下这是只读的:读取时优先使用用户 token,写入仍然使用 bot token,除非你明确选择加入。即使使用 userTokenReadOnly: false,当 bot token 可用时,写入操作仍然优先使用它。
用户 token 在配置文件中配置(不支持环境变量)。对于多账户,设置 channels.slack.accounts.<id>.userToken。
包含 bot + app + user tokens 的示例:
{
channels: {
slack: {
enabled: true,
appToken: "xapp-...",
botToken: "xoxb-...",
userToken: "xoxp-..."
}
}
}显式设置 userTokenReadOnly 的示例(允许用户 token 写入):
{
channels: {
slack: {
enabled: true,
appToken: "xapp-...",
botToken: "xoxb-...",
userToken: "xoxp-...",
userTokenReadOnly: false
}
}
}Token 使用规则
- 读取操作(历史记录、反应列表、固定消息列表、表情符号列表、成员信息、搜索)在配置时优先使用用户 token,否则使用 bot token。
- 写入操作(发送/编辑/删除消息、添加/删除反应、固定/取消固定、文件上传)默认使用 bot token。如果
userTokenReadOnly: false且没有可用的 bot token,Clawdbot 会回退到用户 token。
历史上下文
channels.slack.historyLimit(或channels.slack.accounts.*.historyLimit)控制将多少个最近的频道/群组消息包装到提示中。- 回退到
messages.groupChat.historyLimit。设置为0可禁用(默认 50)。
HTTP 模式(Events API)
当你的网关可以通过 HTTPS 被 Slack 访问时,使用 HTTP webhook 模式(典型用于服务器部署)。 HTTP 模式使用 Events API + Interactivity + Slash Commands,共享一个请求 URL。
设置步骤
- 创建一个 Slack 应用并禁用 Socket Mode(如果仅使用 HTTP,这是可选的)。
- Basic Information → 复制 Signing Secret。
- OAuth & Permissions → 安装应用并复制 Bot User OAuth Token(
xoxb-...)。 - Event Subscriptions → 启用事件并将 Request URL 设置为你的网关 webhook 路径(默认
/slack/events)。 - Interactivity & Shortcuts → 启用并设置相同的 Request URL。
- Slash Commands → 为你的命令设置相同的 Request URL。
请求 URL 示例:
https://gateway-host/slack/events
Clawdbot 配置(最小)
{
channels: {
slack: {
enabled: true,
mode: "http",
botToken: "xoxb-...",
signingSecret: "your-signing-secret",
webhookPath: "/slack/events"
}
}
}多账户 HTTP 模式:设置 channels.slack.accounts.<id>.mode = "http" 并为每个账户提供唯一的 webhookPath,以便每个 Slack 应用可以指向自己的 URL。
清单(可选)
使用此 Slack 应用清单快速创建应用(如果需要,可以调整名称/命令)。如果你计划配置用户 token,请包含用户 scopes。
{
"display_information": {
"name": "Clawdbot",
"description": "Slack connector for Clawdbot"
},
"features": {
"bot_user": {
"display_name": "Clawdbot",
"always_online": false
},
"app_home": {
"messages_tab_enabled": true,
"messages_tab_read_only_enabled": false
},
"slash_commands": [
{
"command": "/clawd",
"description": "Send a message to Clawdbot",
"should_escape": false
}
]
},
"oauth_config": {
"scopes": {
"bot": [
"chat:write",
"channels:history",
"channels:read",
"groups:history",
"groups:read",
"groups:write",
"im:history",
"im:read",
"im:write",
"mpim:history",
"mpim:read",
"mpim:write",
"users:read",
"app_mentions:read",
"reactions:read",
"reactions:write",
"pins:read",
"pins:write",
"emoji:read",
"commands",
"files:read",
"files:write"
],
"user": [
"channels:history",
"channels:read",
"groups:history",
"groups:read",
"im:history",
"im:read",
"mpim:history",
"mpim:read",
"users:read",
"reactions:read",
"pins:read",
"emoji:read",
"search:read"
]
}
},
"settings": {
"socket_mode_enabled": true,
"event_subscriptions": {
"bot_events": [
"app_mention",
"message.channels",
"message.groups",
"message.im",
"message.mpim",
"reaction_added",
"reaction_removed",
"member_joined_channel",
"member_left_channel",
"channel_rename",
"pin_added",
"pin_removed"
]
}
}
}如果你启用原生命令,为每个要暴露的命令添加一个 slash_commands 条目(与 /help 列表匹配)。使用 channels.slack.commands.native 覆盖。
Scopes(当前 vs 可选)
Slack 的 Conversations API 是按类型分 scope 的:你只需要实际使用的对话类型(channels、groups、im、mpim)的 scopes。参见 https://docs.slack.dev/apis/web-api/using-the-conversations-api/ 了解概述。
Bot token scopes(必需)
chat:write(通过chat.postMessage发送/更新/删除消息) https://docs.slack.dev/reference/methods/chat.postMessageim:write(通过conversations.open打开私信用于用户私信) https://docs.slack.dev/reference/methods/conversations.openchannels:history、groups:history、im:history、mpim:historyhttps://docs.slack.dev/reference/methods/conversations.historychannels:read、groups:read、im:read、mpim:readhttps://docs.slack.dev/reference/methods/conversations.infousers:read(用户查找) https://docs.slack.dev/reference/methods/users.inforeactions:read、reactions:write(reactions.get/reactions.add) https://docs.slack.dev/reference/methods/reactions.get https://docs.slack.dev/reference/methods/reactions.addpins:read、pins:write(pins.list/pins.add/pins.remove) https://docs.slack.dev/reference/scopes/pins.read https://docs.slack.dev/reference/scopes/pins.writeemoji:read(emoji.list) https://docs.slack.dev/reference/scopes/emoji.readfiles:write(通过files.uploadV2上传) https://docs.slack.dev/messaging/working-with-files/#upload
User token scopes(可选,默认只读)
如果你配置 channels.slack.userToken,在 User Token Scopes 下添加这些。
channels:history、groups:history、im:history、mpim:historychannels:read、groups:read、im:read、mpim:readusers:readreactions:readpins:reademoji:readsearch:read
目前不需要(但将来可能需要)
mpim:write(仅当我们通过conversations.open添加群组私信打开/私信启动时)groups:write(仅当我们添加私有频道管理:创建/重命名/邀请/归档时)chat:write.public(仅当我们想要向 bot 不在的频道发布时) https://docs.slack.dev/reference/scopes/chat.write.publicusers:read.email(仅当我们需要来自users.info的电子邮件字段时) https://docs.slack.dev/changelog/2017-04-narrowing-email-accessfiles:read(仅当我们开始列出/读取文件元数据时)
配置
Slack 仅使用 Socket Mode(无 HTTP webhook 服务器)。提供两个 tokens:
{
"slack": {
"enabled": true,
"botToken": "xoxb-...",
"appToken": "xapp-...",
"groupPolicy": "allowlist",
"dm": {
"enabled": true,
"policy": "pairing",
"allowFrom": ["U123", "U456", "*"],
"groupEnabled": false,
"groupChannels": ["G123"],
"replyToMode": "all"
},
"channels": {
"C123": { "allow": true, "requireMention": true },
"#general": {
"allow": true,
"requireMention": true,
"users": ["U123"],
"skills": ["search", "docs"],
"systemPrompt": "Keep answers short."
}
},
"reactionNotifications": "own",
"reactionAllowlist": ["U123"],
"replyToMode": "off",
"actions": {
"reactions": true,
"messages": true,
"pins": true,
"memberInfo": true,
"emojiList": true
},
"slashCommand": {
"enabled": true,
"name": "clawd",
"sessionPrefix": "slack:slash",
"ephemeral": true
},
"textChunkLimit": 4000,
"mediaMaxMb": 20
}
}Tokens 也可以通过环境变量提供:
SLACK_BOT_TOKENSLACK_APP_TOKEN
确认反应通过全局的 messages.ackReaction + messages.ackReactionScope 控制。使用 messages.removeAckAfterReply 在 bot 回复后清除确认反应。
限制
- 出站文本被分块到
channels.slack.textChunkLimit(默认 4000)。 - 可选的换行分块:设置
channels.slack.chunkMode="newline"在长度分块之前按空行(段落边界)分割。 - 媒体上传受
channels.slack.mediaMaxMb限制(默认 20)。
回复线程
默认情况下,Clawdbot 在主频道中回复。使用 channels.slack.replyToMode 控制自动线程:
| 模式 | 行为 |
|---|---|
off | **默认。**在主频道回复。仅在触发消息已在线程中时才线程回复。 |
first | 第一次回复进入线程(在触发消息下),后续回复进入主频道。适用于保持上下文可见,同时避免线程混乱。 |
all | 所有回复都进入线程。保持对话独立,但可能会降低可见性。 |
该模式适用于自动回复和代理工具调用(slack sendMessage)。
按聊天类型的线程
你可以通过设置 channels.slack.replyToModeByChatType 为每种聊天类型配置不同的线程行为:
{
channels: {
slack: {
replyToMode: "off", // 频道的默认值
replyToModeByChatType: {
direct: "all", // 私信始终线程
group: "first" // 群组私信/MPIM 线程第一次回复
},
}
}
}支持的聊天类型:
direct:1对1 私信(Slackim)group:群组私信 / MPIM(Slackmpim)channel:标准频道(公共/私有)
优先级:
replyToModeByChatType.<chatType>replyToMode- 提供程序默认值(
off)
旧的 channels.slack.dm.replyToMode 在没有设置聊天类型覆盖时仍被接受作为 direct 的回退。
示例:
仅线程私信:
{
channels: {
slack: {
replyToMode: "off",
replyToModeByChatType: { direct: "all" }
}
}
}线程群组私信但保持频道在根目录:
{
channels: {
slack: {
replyToMode: "off",
replyToModeByChatType: { group: "first" }
}
}
}使频道线程化,保持私信在根目录:
{
channels: {
slack: {
replyToMode: "first",
replyToModeByChatType: { direct: "off", group: "off" }
}
}
}手动线程标记
对于精细控制,在代理响应中使用这些标记:
[[reply_to_current]]— 回复触发消息(启动/继续线程)。[[reply_to:<id>]]— 回复特定的消息 id。
会话 + 路由
- 私信共享
main会话(类似 WhatsApp/Telegram)。 - 频道映射到
agent:<agentId>:slack:channel:<channelId>会话。 - 斜杠命令使用
agent:<agentId>:slack:slash:<userId>会话(前缀可通过channels.slack.slashCommand.sessionPrefix配置)。 - 如果 Slack 不提供
channel_type,Clawdbot 从频道 ID 前缀(D、C、G)推断,并默认为channel以保持会话键稳定。 - 原生命令注册使用
commands.native(全局默认"auto"→ Slack 关闭),可以通过channels.slack.commands.native按工作区覆盖。文本命令需要独立的/...消息,可以通过commands.text: false禁用。Slack 斜杠命令在 Slack 应用中管理,不会自动删除。使用commands.useAccessGroups: false绕过命令的访问组检查。 - 完整命令列表 + 配置:斜杠命令
私信安全(配对)
- 默认:
channels.slack.dm.policy="pairing"— 未知私信发送者获得配对码(1 小时后过期)。 - 通过以下方式批准:
clawdbot pairing approve slack <code>。 - 允许任何人:设置
channels.slack.dm.policy="open"和channels.slack.dm.allowFrom=["*"]。 channels.slack.dm.allowFrom接受用户 ID、@handles 或电子邮件(在 tokens 允许时在启动时解析)。向导接受用户名并在设置时在 tokens 允许时将它们解析为 id。
群组策略
channels.slack.groupPolicy控制频道处理(open|disabled|allowlist)。allowlist要求频道在channels.slack.channels中列出。- 如果你只设置
SLACK_BOT_TOKEN/SLACK_APP_TOKEN而从不创建channels.slack部分,运行时默认groupPolicy为open。添加channels.slack.groupPolicy、channels.defaults.groupPolicy或频道白名单以锁定它。 - 配置向导接受
#channel名称并在可能时将它们解析为 ID(公共 + 私有);如果存在多个匹配,它更喜欢活动频道。 - 启动时,Clawdbot 将白名单中的频道/用户名解析为 ID(在 tokens 允许时)并记录映射;未解析的条目保持为输入的样式。
- 要不允许任何频道,设置
channels.slack.groupPolicy: "disabled"(或保持空白名单)。
频道选项(channels.slack.channels.<id> 或 channels.slack.channels.<name>):
allow:在groupPolicy="allowlist"时允许/拒绝频道。requireMention:频道的提及门控。allowBots:在此频道中允许 bot 编写的消息(默认:false)。users:可选的每个频道用户白名单。skills:技能过滤器(省略 = 所有技能,空 = 无)。systemPrompt:频道的额外系统提示(与主题/目的结合)。enabled:设置为false以禁用频道。
传递目标
将这些与 cron/CLI 发送一起使用:
user:<id>用于私信channel:<id>用于频道
工具操作
Slack 工具操作可以通过 channels.slack.actions.* 控制门控:
| 操作组 | 默认 | 说明 |
|---|---|---|
| reactions | 启用 | 反应 + 列出反应 |
| messages | 启用 | 读取/发送/编辑/删除 |
| pins | 启用 | 固定/取消固定/列出 |
| memberInfo | 启用 | 成员信息 |
| emojiList | 启用 | 自定义表情符号列表 |
安全注意事项
- 写入默认使用 bot token,因此状态更改操作保持在应用的 bot 权限和身份范围内。
- 设置
userTokenReadOnly: false允许用户 token 在 bot token 不可用时用于写入操作,这意味着操作使用安装用户的访问权限运行。将用户 token 视为高度特权,并保持操作门控和白名单严格。 - 如果你启用用户 token 写入,请确保用户 token 包含你期望的写入 scopes(
chat:write、reactions:write、pins:write、files:write),否则这些操作将失败。
注意事项
- 提及门控通过
channels.slack.channels控制(设置requireMention为true);agents.list[].groupChat.mentionPatterns(或messages.groupChat.mentionPatterns)也算作提及。 - 多代理覆盖:在
agents.list[].groupChat.mentionPatterns上设置每个代理的模式。 - 反应通知遵循
channels.slack.reactionNotifications(使用模式为allowlist的reactionAllowlist)。 - Bot 编写的消息默认被忽略;通过
channels.slack.allowBots或channels.slack.channels.<id>.allowBots启用。 - 警告:如果你允许回复其他 bot(
channels.slack.allowBots=true或channels.slack.channels.<id>.allowBots=true),请使用requireMention、channels.slack.channels.<id>.users白名单和/或AGENTS.md和SOUL.md中的清晰护栏防止 bot 到 bot 的回复循环。 - 对于 Slack 工具,反应删除语义在 /tools/reactions 中。
- 附件在被允许且在大小限制内时下载到媒体存储。