如何接收 Webhook 推送?
更新
Webhook 让 Favonis 在任务停下时主动通知你的服务器。任务完成、被取消或暂停时,Favonis 向你填写的地址发送一个请求,里面带着任务的状态、回复和交付的文件,程序不必反复查询任务的进展。
会推送哪些任务
地址按你在这个空间里的身份推送:个人空间里是你个人账号的任务,团队空间里只有你在该团队中发起的任务。团队的所有者和管理员添加的地址,同样收不到其他成员的任务。
- 用 API 密钥发起的任务,每次停下时推送一次。同一轮先暂停、继续后再完成,会推送两次。
- 你的定时任务,每次运行停下时推送一次。
在应用里发起的对话不推送;在应用里打开 API 发起的任务接着对话,新的一轮也不推送。我的电脑中的本地对话和定时任务不推送。
添加地址
- 打开设置 → 开发者,切换到 Webhook 页签,点击右上角的添加地址。
- 填写你的服务器地址。地址必须以 https:// 开头,并且能从公网访问。
- 点击添加。Favonis 先向这个地址发送一个测试请求,10 秒内收到成功的响应才会保存。
- 保存后显示签名密钥,以 whsec_ 开头,只显示这一次。你的服务器用它确认请求确实来自 Favonis,校验方法见开发者文档的 Webhook。
你在每个空间中最多可以添加 10 个地址,团队里其他成员的地址不计在内。每个地址都会收到全部推送。
管理地址
点击地址右侧的 …,菜单中有发送测试、更换签名密钥、停用(已停用的地址是启用)和删除。
发送测试会再推送一次测试请求,推送时间和服务器返回的状态码显示在地址下方。停用的地址旁显示已停用,停用期间的推送不会补发。更换签名密钥后旧密钥立即失效,请及时更新服务器上的配置。
推送失败时
服务器未在 10 秒内返回成功的响应时,Favonis 会在之后约 8.5 小时内多次重试,间隔逐次拉长。重试仍然失败,或者服务器表示这个地址不再使用,地址会被自动停用,你会在通知的消息中收到提醒。排除问题后,回到设置 → 开发者的 Webhook 页签,点击这个地址右侧的 …,再点击启用。
仍需帮助?人工客服于工作日 9:00–18:00在线,你也可以在应用中留言。
联系我们
