在自动化规则中,支持联动三方平台进行协作的动作流转。如工作项的状态联动企业的审批系统工单流转。这种流转方式我们采用Webhook进行支持。
对应模板如下图所示:
目前支持字段变更或者状态变更触发三方平台的动作。
配置
Webhook URL:Webhook请求地址,http:// 或 https:// 开头
HTTP Method:支持POST、GET
Secret:可选,用于对@Webhook请求进行校验。设置了Secret后,发起Webhook请求时,会增加请求头X-Projex-Signature,Value即为Secret的值。
Headers:可选,支持设置请求头
Webhook Body:设置为【空数据】时,发起POST请求时,Body为空;设置为【工作项数据】时,Body内容为当前规则作用的工作项数据(需求、缺陷、任务),示例规则:产品类需求创建时,触发Webhook请求,此时发起Webhook请求时,会将需求的数据对象放在Body中。
【工作项数据】为JSON对象,其中字段如下所示:
字段名 | 字段类型 | 字段描述 |
identifier | String | 工作项的唯一标识 |
gmtCreate | Long | 创建时间,时间戳,单位毫秒 |
gmtModified | Long | 更新时间,时间戳,单位毫秒 |
creator | User | 创建者 |
modifier | User | 最近更新者 |
assignedTo | User | 负责人 |
status | Status | 状态 |
workitemType | WorkitemType | 工作项类型,如 产品类需求…… |
space | Space | 归属项目 |
subject | String | 标题 |
document | Document | 描述 |
parentIdentifier | String | 父工作项的唯一标识,如父需求、父任务 |
customFieldValue | List<CustomValue> | 自定义字段值 |
sprint | List<Sprint> | 迭代 |
tag | List<Tag> | 标签 |
tracker | List<User> | 抄送人 |
participant | List<User> | 参与人 |
verifier | List<User> | 验证者 |
用户类型--User
字段名 | 字段类型 | 字段描述 |
identifier | String | 用户的唯一标识 |
realName | String | 用户真名 |
nickName | String | 用户昵称 |
状态类型 -- Status
字段名 | 字段类型 | 字段描述 |
identifier | String | 状态的唯一标识 |
name | String | 状态中文名称 |
nameEn | String | 状态英文名称 |
工作项类型 -- WorkitemType
字段名 | 字段类型 | 字段描述 |
identifier | String | 工作项类型的唯一标识 |
name | String | 工作项类型的中文名称 |
nameEn | String | 工作项类型的英文名称 |
categoryIdentifier | String | 工作项类别: 需求 -- Req 缺陷 -- Bug 任务 -- Task |
项目类型 -- Space
字段名 | 字段类型 | 字段描述 |
identifier | String | 空间的唯一标识 |
name | String | 空间的名称 |
文档类型 -- Document
字段名 | 字段类型 | 字段描述 |
content | String | 内容 |
迭代 -- Sprint
字段名 | 字段类型 | 字段描述 |
identifier | String | 迭代的唯一标识 |
name | String | 迭代的名称 |
标签 -- Tag
字段名 | 字段类型 | 字段描述 |
identifier | String | 标签的唯一标识 |
name | String | 标签的名称 |
color | String | 颜色 |
测试
配置完成后,可以点击“进行Webhook请求测试”,测试配置是否正确。