使用 Webhook 发送通知
用户可以在流水线中配置 Webhook 通知,为指定地址推送流水线阶段任务运行信息。
流水线任务配置 Webhook 通知
- 在流水线任务节点中,选择添加 Webhook 通知。
-
填写 Webhook 地址,注意 Webhook 地址必须公网可访问。
-
密钥非必填,用于 WebHook 鉴权的方式,通过签名密钥生成请求签名进行鉴权,防止 URL 被恶意请求。
-
选择通知事件,当该流水线的任务进入选择状态后,会触发消息通知。
触发流水线运行
Gitee 流水线发送的 Webhook 请求一律为 Post 请求,任务状态信息的 Payload 示例如下。
{
"job":{
"pipelineId":183,
"pipelineName":"测试流水线",
"stageName":"构建",
"jobName":"java构建",
"buildNumber":19,
"statusCode":"SUCC", // SUCC,FAIL,CANCEL,SKIP
"statusName":"成功",
"pipelineUrl":"https://e.gitee.com/oschina/projects/210455/pipelines/255039/history/426411/stages/741137/jobs/1018636?buildNumber=2"
},
"sources":[
{
"sourceType":"GITEE_GO",
"repoPath":"xiaoxuxuy/test",
"branch":"master",
"commitId":"123123"
},
{
"sourceType":"PIPELINE",
"buildNumber":7,
"upParams":"{\"GITEE_REPO\":\"git/test\",\"GITEE_BRANCH\":\"master1\",\"GITEE_COMMIT\":\"c2a64f66a9536200f9dc464427e793c3444b1113b\"}"
},
{
"sourceType":"CODE_LEVEL_ARTIFACT",
"artifactRepo":"default",
"artifactVersion":"v1.0.0"
}
],
"globalParams":[
{
"key":"test",
"value":"test1"
},
{
"key":"test2",
"value":"test2"
}
]
}