企业自建应用 Webhook 信息推送的建立
功能介绍
企业自建应用的开发者可以给应用添加 Webhook 推送的能力。可以让安装了本应用的企业,全企业范围内特定类别(如任务、项目等)的所有对象变动信息向配置的地址推送。可以创建用于监听、同步和诊断的日志流。
*注意:当前的实现中,企业安装应用后,内容推送会被全企业范围内的变动触发,即,假设建立了任务相关的推送,企业内的所有任务变动都会形成推送,请注意在消费端过滤。我们有计划在将来支持逐资源、细分场景建立 Webhook 订阅的的模式。
建立推送
如何让自己的应用可以发起此类 Webhook 推送:
首先,搭建好接收方的配置,获得接收地址,和对应的解析能力, 本例中假设是这个地址:https://www.consumer.com/helloworld
然后,前往开放平台,开发者后台对应应用的 Webhook 界面, 添加接收地址,比如https://www.consumer.com/helloworld
最后,前往开发者后台对应应用的应用权限界面,给这个应用添加相关资源的权限,比如希望收到任务创建通知的,就是添加任务权限。
在发布后,
-
新安装此应用的企业,如果有被授权类别的对象发生了变动,就形成消息推送给开头定义的地址。
-
已安装此应用的企业,需要主动安装最新版本才会按照最新的推送范围进行推送。
具体推送事件的范围和 payload 的格式说明请参考开放平台相关文档 Webhook 目录下的的介绍。
高级功能
Base64加密
如果你处理报文的系统会涉及大量用户输入,需要对注入攻击等情形进行保护,可以选择对报文体开启 Base64加密
开启后,需要重新发布应用,后续报文消息header 会有Content-Transfer-Encoding : "base64" ,Body 部分则会被 Base64 加密,在接收端解密即可
重启中断推送
如果因为某些原因推送中断了,通常因为下游接收端长期无响应,开发者可以排查完错误后,自助重启推送。
从点击重启到推送实际恢复会有一定的延迟,请等待最多 30分钟后验证。