You need to enable JavaScript to run this app.
导航
Webhook 通知
最近更新时间:2024.09.30 14:33:05首次发布时间:2024.06.05 10:53:30

持续交付提供任务维度的通知提醒,支持通过 Webhook 和飞书机器人两种方式推送任务维度的消息,帮助您及时掌握任务动态。

飞书机器人

通过服务端调用飞书机器人的 hookurl 地址,将任务通知提醒即时推送至飞书。添加飞书机器人方式可参考 飞书开发者指南

  • Webhook 地址:必填,输入飞书机器人的 hookurl 地址。
  • Token:非必填,请求头中携带用于验证推送合法性。
  • 通知内容:飞书机器人支持定制通知内容模板,可选项有 基本信息、触发人、触发事件、触发时间、触发详情、链接地址。默认全部勾选,至少需勾选一项。
  • 自定义通知内容:除了预置的通知内容模板外,支持在输入框中输入自定义通知内容。自定义通知内容可以引用流水线变量,长度限制在 200 个字符以内。
  • 通知条件:多选。可选范围:任务开始、任务成功、任务失败、任务等待中、任务已取消

Webhook 通用格式

将任务通知提醒推送至您的 Webhook 接收平台。

  • Webhook 地址:必填,输入需接收通知的平台的 hookurl 地址。

  • Token:非必填,请求头中携带用于验证推送合法性。

  • 通知内容:支持输入自定义通知内容,长度限制在 200 个字符以内。完整的通知内容会通过 POST 请求发送。详细样例如下:

    说明

    自定义通知内容可以引用流水线变量,引用方式请参见 使用变量

    //任务维度的 Webhook 通用格式通知样例
    {
      "ID": "630443044b292aae4c91****",  //通知记录 ID
      "PipelineName":  "Java项目-dev",  //流水线名称
      "PipelineRunID": "630443044b292aae4c91****",  //流水线运行记录 ID
      "URL": "https://console.volcengine.com/cp/workspace/****/pipeline/****/detail/record/****",  //流水线运行记录 url
      "TriggerBy": {
        "AccountId": 210013****,  //主账号 ID
        "UserId": 107****,  //运行人 ID
        "Name": ""  //用户名
      },
      "Status": "Running",  //任务状态,取值包含 Pending, Running, Succeeded, Canceled, Timeout, Waiting, Failed
      "StageName": "阶段1",  //阶段名称
      "StageID": "***",  //阶段 ID
      "TaskName": "命令执行",  //任务名称
      "TaskID": "***",  //任务 ID
      "CustomContent": "***"  //自定义内容
    }
    
  • 通知条件 :
    多选。可选范围:任务开始、任务成功、任务失败、任务等待中、任务已取消