Webhooks

网关可以为外部触发器暴露一个小型的 HTTP webhook 端点。

启用

{
  hooks: {
    enabled: true,
    token: "shared-secret",
    path: "/hooks"
  }
}

注意：

• hooks.token 在 hooks.enabled=true 时是必需的。
• hooks.path 默认为 /hooks。

认证

每个请求必须包含 hook token。优先使用 header：

• Authorization: Bearer <token>（推荐）
• x-openclaw-token: <token>
• ?token=<token>（已弃用；记录警告并将在未来主要版本中删除）

端点

POST /hooks/wake

负载：

{ "text": "系统行", "mode": "now" }

• text 必需（字符串）：事件的描述（例如"收到新邮件"）。
• mode 可选（now | next-heartbeat）：是否触发立即心跳（默认 now）或等待下次定期检查。

效果：

• 为主会话加入系统事件队列
• 如果 mode=now，触发立即心跳

POST /hooks/agent

负载：

{
  "message": "运行这个",
  "name": "邮件",
  "sessionKey": "hook:email:msg-123",
  "wakeMode": "now",
  "deliver": true,
  "channel": "last",
  "to": "+15551234567",
  "model": "openai/gpt-5.2-mini",
  "thinking": "low",
  "timeoutSeconds": 120
}

• message 必需（字符串）：智能体要处理的提示或消息。
• name 可选（字符串）：hook 的人类可读名称（例如"GitHub"），在会话摘要中用作前缀。
• sessionKey 可选（字符串）：用于识别智能体会话的键。默认为随机的 hook:<uuid>。使用一致的键允许在 hook 上下文内进行多轮对话。
• wakeMode 可选（now | next-heartbeat）：是否触发立即心跳（默认 now）或等待下次定期检查。
• deliver 可选（布尔值）：如果 true，智能体的响应将发送到消息通道。默认为 true。仅心跳确认的响应自动跳过。
• channel 可选（字符串）：消息传递的通道。选项之一：last、whatsapp、telegram、discord、slack、mattermost（插件）、signal、imessage、msteams。默认为 last。
• to 可选（字符串）：通道的接收者标识符（例如 WhatsApp/Signal 的电话号码，Telegram 的聊天 ID，Discord/Slack/Mattermost（插件）的通道 ID，MS Teams 的对话 ID）。默认为主会话中最后一个接收者。
• model 可选（字符串）：模型覆盖（例如 anthropic/claude-3-5-sonnet 或别名）。如果受限，必须在允许的模型列表中。
• thinking 可选（字符串）：思考级别覆盖（例如 low、medium、high）。
• timeoutSeconds 可选（数字）：智能体运行的最大持续时间（秒）。

效果：

• 运行隔离的智能体轮次（自己的会话键）
• 始终发布摘要到主会话
• 如果 wakeMode=now，触发立即心跳

POST /hooks/<name>（映射）

自定义 hook 名称通过 hooks.mappings 解析（见配置）。映射可以将任意负载转换为 wake 或 agent 动作，可选带模板或代码转换。

映射选项（摘要）：

• hooks.presets: ["gmail"] 启用内置的 Gmail 映射。
• hooks.mappings 让你在配置中定义 match、action 和模板。
• hooks.transformsDir + transform.module 加载 JS/TS 模块用于自定义逻辑。
• 使用 match.source 保留通用摄入端点（负载驱动路由）。
• TS 转换需要 TS 加载器（例如 bun 或 tsx）或运行时预编译的 .js。
• 在映射上设置 deliver: true + channel/to 以将回复路由到聊天界面（channel 默认为 last 并回退到 WhatsApp）。
• allowUnsafeExternalContent: true 为该 hook 禁用外部内容安全包装（危险；仅用于受信任的内部源）。
• openclaw webhooks gmail setup 为 openclaw webhooks gmail run 编写 hooks.gmail 配置。 有关完整的 Gmail watch 流程，见 Gmail Pub/Sub。

响应

• 200 表示 /hooks/wake
• 202 表示 /hooks/agent（异步运行已开始）
• 401 表示认证失败
• 400 表示无效负载
• 413 表示负载过大

示例

curl -X POST http://127.0.0.1:18789/hooks/wake \
  -H 'Authorization: Bearer SECRET' \
  -H 'Content-Type: application/json' \
  -d '{"text":"收到新邮件","mode":"now"}'

curl -X POST http://127.0.0.1:18789/hooks/agent \
  -H 'x-openclaw-token: SECRET' \
  -H 'Content-Type: application/json' \
  -d '{"message":"总结收件箱","name":"邮件","wakeMode":"next-heartbeat"}'

使用不同模型

在 agent 负载（或映射）上添加 model 以覆盖该运行的模型：

curl -X POST http://127.0.0.1:18789/hooks/agent \
  -H 'x-openclaw-token: SECRET' \
  -H 'Content-Type: application/json' \
  -d '{"message":"总结收件箱","name":"邮件","model":"openai/gpt-5.2-mini"}'

如果你强制执行 agents.defaults.models，确保覆盖模型包含在其中。

curl -X POST http://127.0.0.1:18789/hooks/gmail \
  -H 'Authorization: Bearer SECRET' \
  -H 'Content-Type: application/json' \
  -d '{"source":"gmail","messages":[{"from":"Ada","subject":"Hello","snippet":"Hi"}]}'

安全

• 将 hook 端点保持在回环、tailnet 或受信任的反向代理后面。
• 使用专用的 hook token；不要重复使用网关认证 token。
• 避免在 webhook 日志中包含敏感的原始负载。
• Hook 负载默认被视为不受信任，并用安全边界包装。 如果必须为特定 hook 禁用此功能，在该 hook 的映射中设置 allowUnsafeExternalContent: true（危险）。