跳到主要内容

Webhook

功能简介​

Webhooks允许你在聊天机器人系统中某些事件发生时，实时接收 HTTP 通知。 这对于与其他系统集成、跟踪使用情况或实现自定义业务逻辑非常有用。 使用场景

  • 记录用户使用情况，限制用户使用
  • 在你自己的系统中记录聊天历史

事件​

目前，我们支持以下事件：

  • chat - 当用户向聊天机器人发送消息时触发

使用方法​

  1. 设置webhook 创建机器人时，添加webhooks
  2. 解析响应 Webhook 数据(payload)格式 当事件发生时，我们会向你配置的 Webhook URL 发送一个包含 JSON 数据的 POST 请求。
  • 请求格式
  {
    "bot_id": "string",
    "chat_id": "string",
    "role_id": "string",
    "role_variables": "string",
    "question": "string",
    "response": {
        "id": "string",
        "content": "string",
        "created_at": "string",
    },
}
  • 请求头
Content-Type: application/json
User-Agent: AskTable-Webhook

最佳实践​

  • 你的 Webhook 接收端应返回 2xx 状态码以确认接收成功
  • 通过请求头验证 Webhook 来源
  • 处理重复事件消息（实现幂等性）

其他​

速率限制与重试策略

  • 传送失败将采用指数退避算法进行重试
  • 每个事件最多重试 5 次，分别等待 5s, 10s, 20s, 40s