WebHook 接口文档说明
⚠️ WebHook 核心规则：用于接收第三方平台（如机器人、应用）的实时回调数据，需通过 密钥 验证身份；官方平台与框架使用不同地址（HTTP/WS协议区分），密钥需替换为你的官方机器人密钥，请勿泄露。
WebHook 关键地址（替换 {密钥} 为你的实际密钥）
1. 官方平台填写地址（HTTP协议）
用于在官方平台配置回调接收地址
webhook.qyuan.asia/hook/{密钥}
2. 框架填写地址（WS协议）
用于适配 beewebhook 框架的实时通信
ws://webhook.qyuan.asia/ws/{密钥}
适配框架：
专为 beewebhook 框架设计，支持高并发回调
通信协议：
官方平台（HTTP）、框架（WebSocket）
核心功能：
接收第三方平台实时回调数据（如消息推送、事件通知），并转发至框架处理
安全机制：
通过密钥验证身份，防止非法回调请求
Header 参数
<<<<<<<<<<<| 参数名称
<<<<<<<<<<< | 参数类型
<<<<<<<<<<< | 示例值
<<<<<<<<<<< | 参数说明
|
| 无强制参数 |
— |
— |
部分第三方平台可能要求添加自定义Header（如X-Token），需根据平台规则配置 |
请求参数（密钥验证）
<<<<<<<<<<<| 参数名称
<<<<<<<<<<< | 参数位置
<<<<<<<<<<< | 参数类型
<<<<<<<<<<< | 示例值
<<<<<<<<<<< | 参数说明
|
| 密钥 |
URL路径（非Body） |
string |
abc123xyz（你的官方机器人密钥） |
必填，身份验证核心参数，需替换为你的官方机器人密钥，在URL中替换 {密钥} 占位符 |
使用示例
// 1. 官方平台配置示例（替换密钥为实际值）
配置地址：webhook.qyuan.asia/hook/abc123xyz
说明：官方平台触发事件时，会向该地址发送HTTP POST请求，携带回调数据
// 2. 框架配置示例（替换密钥为实际值）
框架地址：ws://webhook.qyuan.asia/ws/abc123xyz
说明：框架通过WebSocket连接该地址，实时接收回调数据，支持高并发
// 3. 回调数据格式示例（JSON）
// 官方平台发送的HTTP POST请求Body示例
{
"event": "message", // 事件类型（如消息事件）
"data": {
"content": "用户消息内容",
"from": "user123" // 来源标识
},
"timestamp": 1740000000000 // 事件时间戳
}
注意事项
- 1. 密钥是身份验证关键，请勿泄露给他人，避免被非法利用。
- 2. 官方平台使用 HTTP 地址，框架使用 WebSocket 地址，请勿混淆协议。
- 3. 高并发场景下，建议确保框架能及时处理回调数据，避免消息堆积。
- 4. 若回调失败，可检查密钥是否正确、网络是否通畅，或在官方群聊反馈。