webhook 分享链接

禅道集成了Webhook功能，可以通过发送 JSON 格式的数据到第三方hook地址，进行消息集成，包括钉钉、企业微信以及飞书。下面介绍如何配置该功能。

1. 配置Webhook

点击“后台”-“通知设置”-“Webhook”。

禅道内置了多种类型选项，根据不同的选项填写不同的信息。

注：

• 名称：必填项
• Hook地址：必填项，从第三方获取。
• 发送方式：同步意味着在禅道内进行操作之后会立刻发送消息给 hook 地址。异步需要在“后台”-“系统”-“定时”下设置定时发送任务。
• 关联产品：空意味着对禅道内的所有操作都会发送给 hook 地址，否则只发送所选择的产品相关的操作。
• 关联执行：空意味着对禅道内的所有操作都会发送给 hook 地址，否则只发送所选择的执行相关的操作。
• 触发动作：指的是进行某种操作时，向设定的 hook 地址发送消息。可以在“后台”-“通知”-“设置”中设置。如果你了解基于禅道的二次开发，可以通过扩展 zentao/module/webhook/config.php 文件来修改此项内容。
• 参数类型：发送的数据的属性，包括

{
    "objectType": "",  //对象类型，可以为空
    "objectID": "",    //对象ID，可以为空
    "product": "",     //关联产品ID，可以为空
    "project": "",     //关联执行ID，可以为空
    "action": "",      //动作，可以为空
    "actor": "",       //操作者，可以为空
    "date": "",        //操作时间，可以为空
    "comment": "",     //备注，可以为空
    "text": ""         //操作内容，包含操作对象的url，必选。
}

2. 配置钉钉群通知机器人

2.1 创建钉钉机器人

在钉钉中，点击“群设置”-“智能群助手”-“添加机器人”。

选择“自定义”，通过Webhook接入自定义服务。

点击“添加”。

在安全设置下，勾选“加签”。

禅道目前仅支持加签的方式。在禅道内添加钉钉群通知机器人类型的webhook时，把这里的密钥复制，粘贴到禅道“后台"-"通知"-"webhook"的钉钉群通知机器人类型的webhook的密钥栏里。

点击“完成”，得到一个Webhook的地址。

2.2 配置机器人Webhook

机器人添加完成后，在禅道中添加一个类型为“钉钉群通知机器人”的webhook，填入从钉钉机器人获取的密钥和webhook 地址，即可发送消息到钉钉。

注：

• 钉钉的消息发送方式默认为同步发送，不能修改。
• 目前钉钉对自定义机器人发送消息的频率做了限制，每分钟最多发送20条消息。

3. 配置钉钉工作消息通知

3.1 创建钉钉应用

在钉钉开放平台注册，点击“应用开发”-“企业内部开发”-“小程序”-“创建应用”。

填上应用名称、描述等，点击“确认创建”。自动返回应用的“基础信息”页面，获得应用的ID、Key和Secret。

点击“开发管理”，输入服务器出口IP。填写禅道所在服务器的外网IP。这个IP在钉钉的开放平台中，没有被使用过。一个应用对应一个IP。

3.2 配置Webhook

选择“钉钉工作消息通知类型”作为所添加Webhook的类型，将上图中的钉钉AgentId、钉钉AppKey和钉钉AppSecret填入相应的位置。

3.3 同步和绑定用户

创建“钉钉工作消息通知”类型的应用后，还需要同步和绑定用户。点击“权限管理”-“通知接口数据”，获取企业员工的通讯录数据的权限。

默认权限范围是“全部员工”。如果只需要部分员工的，可以点击“授权部门”右侧的添加按钮可进行选择。

点击“通讯录管理”，录入公司部门及成员信息。

注：钉钉中添加应用的人员设置中的开发人员需要有通讯录管理权限。

然后，去禅道中点击“绑定用户”按钮，进行用户的同步和关联。

绑定用户页面：

• 已绑定的用户不会显示到钉钉Userid列表里；
• 可以解除绑定的用户；
• 可以修改绑定的用户。

用户绑定成功后，根据禅道“后台”-“通知”-“设置”，绑定的用户就可以在钉钉里接收到禅道里与该用户相关的消息。

4. 配置企业微信群机器人