Webhook 接入点(已废弃)
功能已废弃
Webhook 接入点已废弃,后续版本可能移除。新插件请使用 动态路由 实现外部 HTTP 接入。
新项目应该怎么做
如果您需要接收 GitHub、GitLab、Sentry、监控系统或自定义服务的 HTTP 推送,请直接使用动态路由。
动态路由更适合新插件:
- 支持完整的 FastAPI 路由能力
- 可以清晰区分
GET、POST、PUT、DELETE等方法 - 更容易组织 RESTful API
- 更方便处理请求参数、响应、鉴权和文件上传
- 与当前插件开发文档保持一致
→ 查看 动态路由
已有 Webhook 插件怎么办
如果您的插件已经使用旧 Webhook 接入点:
- 先确认当前插件在现有版本中仍能正常工作
- 新增功能优先写到动态路由中
- 将外部平台的回调地址逐步切换到新的动态路由地址
- 迁移完成后,再移除旧 Webhook 处理逻辑
迁移期间注意
迁移外部回调时,请先在测试环境验证签名校验、鉴权、响应状态码和超时行为,再切换生产环境回调地址。
常见迁移对应关系
| 旧 Webhook 用法 | 动态路由中的做法 |
|---|---|
| 接收外部 POST 推送 | 注册一个 POST 路由 |
| 根据请求头区分事件类型 | 在路由处理函数中读取请求头 |
| 验证共享密钥或签名 | 在动态路由中实现鉴权校验 |
| 向指定会话发送通知 | 在处理完成后调用消息 API |
| 处理耗时任务 | 使用异步任务或后台任务模式 |
保留本文的原因
本文仅用于提醒旧功能状态和指向迁移路径,不再提供旧 Webhook 的完整开发教程。请不要在新插件中继续使用旧 Webhook 接入点。
