HTTP Webhook 频道提供 REST API,用于将外部服务与 IronClaw 集成。Documentation Index
Fetch the complete documentation index at: https://docs.ironclaw.com/llms.txt
Use this file to discover all available pages before exploring further.
如果您还没有设置智能体,请先查看我们的快速开始指南
启用 Webhook
安全
共享密钥验证
配置 webhook 密钥以验证请求:X-Webhook-Secret 请求头发送。
速率限制
- 请求体大小:最大 64 KB
- 速率:每个 IP 每分钟 60 个请求
发送消息
请求格式
响应格式
请求字段
| 字段 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id | string | 是 | 用户标识符 |
message | string | 是 | 消息内容 |
conversation_id | string | 否 | 继续现有对话 |
metadata | object | 否 | 任意元数据 |
响应字段
| 字段 | 类型 | 描述 |
|---|---|---|
job_id | string | 用于状态检查的任务 UUID |
status | string | queued、running、completed |
response | string | 智能体响应(完成时) |
检查状态
错误响应
| 状态码 | 含义 |
|---|---|
400 | 无效的请求体 |
401 | 缺少或无效的密钥 |
429 | 超出速率限制 |
500 | 服务器错误 |
集成示例
GitHub Webhook
配置 GitHub 将事件发送到您的 IronClaw webhook URL:Zapier
使用 Zapier 的 Webhook 操作将事件发送到 IronClaw。自定义脚本
故障排除
连接被拒绝
连接被拒绝
- 检查 IronClaw 是否在运行
- 验证
HTTP_PORT正确 - 检查防火墙:
sudo ufw allow 8080
401 未授权
401 未授权
- 包含
X-Webhook-Secret请求头 - 验证密钥与配置匹配
429 请求过多
429 请求过多
- 速率限制:每分钟 60 个请求
- 实现指数退避
消息未处理
消息未处理
- 检查日志:
RUST_LOG=ironclaw=debug ironclaw run - 验证 JSON 格式
- 检查
user_id有效