v2.116.0 -支持 Webhook 通知

更新时间:20200305

更新内容:

  1. 私有部署支持开启插件系统;

  2. 支持添加、管理、配置、启用监听器(webhook模式)

使用指南:(功能介绍/使用场景/操作指引)

在某些情况下除了 ONES 系统通知方式以外,用户对于外部事件的通知,支持通过 Webhook 的方式,用户在提供了钩子地址进行配置后,即可在第三方获取 ONES 的系统消息。例如:应用想要获取新增的工作或状态变更,可以通过 Webhook 接收通知消息。

一、使用方法

进入团队配置中心 > 外部通知 - 监听器,即可配置监听器名称、发送模式、URL、设置监听事件和范围,测试成功并保存后,即可在第三方进行监听。

仅限已开启插件系统的私有部署版本,未启用 Webhook 的用户可联系我们服务人员进行升级。

二、Webhook 响应机制

ONES 将系统事件的参数,通过 HTTP 协议以 POST 方式通知指定的 URL。在接收到 ONES 的 Webhook 请求后,若因为网络不佳等情况 5 秒内未返回消息 ID 的状态码,系统会认为通知失败,启用重传机制

重传机制:每条消息至多重发 3 次,当系统 30分钟未检测到任何应答(期间系统每 5 分钟发送一次心跳消息),则判定对端的 Web 服务已失效,将停用 Webhook,用户可在配置界面手动重启。

三、Webhook 消息字段说明

消息交互方式分为两种:①系统通知;②心跳信息

  • 用户无论是收到的系统通知,还是心跳消息,都需要返回其 ID。如果未收到返回消息,则判定当前消息发送失败。

  • 接收通知消息的服务可以按照需要继续处理,心跳消息可以直接应答后抛弃。通知消息和心跳消息都是 json 标准的字符串。

  • 我们在消息中提供了部分描述信息,以便于用户的使用。根据这些描述信息,用户可以直接得到一个可读性高的消息(与我们在微信或者 ONES 网页右上角收到的通知一样),而不需要根据某些 ID 去查询其对应的值。

{
    "id": "hhqS4Wa3UQYJeHZv"
}

最后更新于