通用 Webhook 触发

通用 Webhook 触发用于代码源以外的第三方工具或自有系统触发流水线运行。一条流水线支持配置多个通用 Webhook 触发器。本文为您介绍如何配置通用 Webhook 触发规则。

前提条件

已创建流水线，具体操作请参见 创建流水线。

操作步骤

1. 使用以下任意一种方式进入添加触发器面板。

   • 编辑流水线

     1. 在流水线列表中选择目标流水线，单击 ... > 编辑，进入当前流水线的流程编排页签。
     2. 在代码源&触发器面板，单击 添加 > 通用 Webhook 触发。

   • 触发器快捷入口

     1. 流水线列表中，单击目标流水线名称，进入当前流水线的运行记录页签。
     2. 单击 触发器，切换至触发器页签。
     3. 单击 添加触发器 > 通用 Webhook 触发。

2. 配置通用 Webhook 触发规则。

   

   配置项	说明
   触发器名称	自定义 Webhook 触发器的名称。同一流水线下的 Webhook 触发器名称不可重复。
   URL	展示当前流水线的 Webhook URL，流水线通过该 URL 接收 Webhook 触发消息。
   运行时变量	可选配置。运行时变量用于配置 Webhook 触发流水线运行时，动态变量的实际使用值。如果不配置，动态变量将使用默认值。 例如：如下图所示，提前配置希望流水线传递的动态变量：参数 a，默认值 1，并开启动态设置。 配置运行时变量，参数选择 a，运行值设置为 10。则 Webhook 触发流水线运行时，a 的取值为 10。 不配置运行时变量，则 Webhook 触发流水线运行时，a 的取值为默认值 1。
   备注	填写当前触发器的备注信息，可以为空。
   运行时分支	当流水线存在代码源时，支持配置运行时使用的代码分支。 开启：可选择 Webhook 触发流水线时使用的代码分支。如果希望 Webhook 触发时使用非默认分支，请配置此参数。例如：同一条流水线，代码源默认分支为主分支，但希望 Webhook 触发特定分支，则可通过配置此参数实现。 关闭： Webhook 触发流水线时会使用代码源配置的默认分支。

   

3. 单击 确定，完成 Webhook 触发配置。

4. 如果从编辑流水线入口进入，需单击右下角 保存，保存流水线配置。

后续操作

将流水线的 URL 配置至您的平台，否则流水线无法正常接收 Webhook 触发消息。