本文介绍 Webhook 全生命周期管理能力，包含功能定位、页面说明、创建、查看、编辑、删除等完整操作流程。

Webhook 是 REST API 数据源专属扩展能力，依托已配置的第三方接口域名、鉴权信息，支持平台主动向外发起 HTTP 请求，实现事件回调、数据推送、跨系统业务联动，仅 REST API 类型数据源 提供该功能，其余数据源无 Webhooks 管理标签页。

Webhook与本体Action Type的绑定关系

Webhook 核心用途之一就是作为本体 Action Type 的底层执行通道，二者是底层执行载体与上层业务动作的绑定依赖关系：

1. Webhook 只负责技术层面的接口调用逻辑，本身无业务含义，一条 Webhook 可以被多个不同的 Action Type 复用；
2. Action Type 是本体层面定义的业务操作，仅描述业务行为、本体实体字段、自定义业务入参，无法独立完成对外系统同步，必须绑定 Webhook 才能执行；
3. 数据传递逻辑：触发 Action Type 执行时，平台会自动读取 Action 自定义入参，填充到 Webhook 预设的请求模板中，再通过 Webhook 配置的接口规则推送至第三方系统。

前提条件

• 已创建完成REST API数据源；
• 当前账号拥有该 REST API 数据源管理权限。

Webhook页面入口说明

1. 登录百度胜算控制台，在选中的工作空间操作列单击打开按钮，进入空间内。
2. 侧边导航依次单击数据连接与集成>数据源，在数据源列表单击Rest API数据源类型的任务名称。
3. 进入当前数据源详情页面，通过Tab标签切换至Webhooks页面。

创建Webhook

在Webhooks页面，单击右上角的创建按钮，进入Webhook配置界面。Webhook需通过输入Block、调用请求、输出Block三者协同完成，三模块分工独立、流程依次流转，共同实现事件捕获>接口调>结果分全链路回调逻辑。

输入Block

作为 Webhook 的数据源与触发入口，定义您执行Webhook时可以传入的参数，具体配置说明如下：

表1 输入Block配置参数说明

配置项名称	说明
参数名称	必填，支持英文、数字、下划线，必须以字母开头，长度为1～128个字符，输入参数名不得重复。
参数类型	必填，下拉单选，默认为string，可选范围：String、Boolean、Integer、Long、Double、Date、Timestamp、Struct、Array（String、Boolean、Integer、Long、Double、Date、Timestamp、Struct），当选择 Struct 类型时，支持在当前参数下添加子节点，Struct类型下方至少有一个子节点，层级最多为5层，第五层级不可选Struct。
描述	非必填，输入对当前参数的描述。
必填	非必填，选择参数是否必填。
默认值	非必填，输入当前参数的默认值，Struct类型的默认值在子节点处填写。
操作	删除：删除当前参数；添加：在当前参数下添加子节点（仅Struct类型具备）。

调用请求

调用请求是 Webhook 实现对外 HTTP 接口推送的核心执行模块，依托当前 REST API 数据源预配置的域名、鉴权凭证发起网络请求，支持同 VPC 内网、外网两种访问网络范围。具体配置说明如下：

若当前HTTP接口为公网接口，请确保数据源所属位置绑定资源组里的源链接与集成实例已开启公网访问能力。

表2 调用请求配置参数说明

配置项名称	说明
名称	必填，支持中文、英文、数值以及-./()特殊字符，不超过128字符，默认为"调用请求${自增值}"，模块之间名称不得重复。
请求方式	必填，下拉单选，可选范围：GET、POST，默认为GET。
baseURL	必填，下拉单选，可选范围为当前数据源的域名组的baseURL。
api path	非必填，以/开头，可以使用"{"引用参数。
请求参数	默认为空，无参数，可单击添加参数按钮，添加请求参数。 参数名：必填，输入参数名不得重复。 参数值：非必填，可直接输入或点击右侧按钮引用参数。 描述：非必填，输入参数描述。 操作：单击删除按钮，删除该参数。
鉴权	仅作为展示，根据认证方式展示数据源、认证方式、用户名、密码、bear token、key、value、add to等信息。
请求头	默认为空，无参数，可单击添加参数按钮，添加请求参数。 参数名：必填，输入参数名不得重复。 参数值：非必填，可直接输入或点击右侧按钮引用参数。 描述：非必填，输入参数描述。 操作：单击删除按钮，删除该参数。
请求体	支持none、form-data、x-www-form-urlencoded、raw四种请求体类型。 none：无请求体。 form-data：以键值对形式传递数据，支持文件上传。默认无参数，单击添加参数按钮，进行新增。 x-www-form-urlencoded：以键值对形式传递数据，使用application/x-www-form-urlencoded格式。默认无参数，单击添加参数按钮，进行新增。 RAW：包括JSON、XML、TEXT、HTML格式。根据选择的格式展示不同提示内容“请输入${格式}数据，可以使用"{{"引用参数”。
添加调用请求	支持添加多个调用请求。

输出Block

用于接收第三方接口返回的响应数据，定义Webhook执行后返回的参数。

表3 输出Block配置参数说明

配置项名称	说明
参数名称	必填，支持英文、数字、下划线，必须以字母开头，长度为1～128个字符，输入参数名不得重复。
参数类型	必填，下拉单选，默认为string，可选范围同输入Block。
参数值	非必填，可直接输入或点击右侧按钮引用参数。
描述	非必填，输入对当前参数的描述。
操作	删除或添加子节点。

基本信息

单击右侧基本信息按钮，可查看当前Webhook的名称、创建人、创建时间、修改人、修改时间、描述和数据源，并支持修改节点名称与描述。

调试

完成节点配置后，单击右侧测试按钮，系统会根据Block的输入变量展示全部输入项供您填写。您输入完成后，单击运行按钮，自动展开调用详情：

• 展示从第一个调用请求到最终输出参数的完整执行过程
• 执行明细：按执行顺序展示各模块的运行信息
• 详细内容：调用请求模块以json格式展示输入输出，输出模块以json格式按定义的输出参数结构展示

历史版本

单击右侧历史版本按钮，展示版本列表，包括版本号、时间、创建人、版本描述，版本支持查看、恢复到此版本、删除。

保存与发布

• 在调试完成后，可单击保存按钮，保存当前Webhook。
• 单击发布按钮，在发布对话框可对版本号、版本描述进行修改，发布后本体Action Type、数据任务可正式调用该Webhook。

查看Webhooks列表

在Webhooks页面，支持通过名称搜索Webhook。

表4 Webhooks列表字段说明

列表项名称	说明
名称	展示Webhook名称。
状态	已发布/未发布，支持按状态筛选。
描述	展示Webhook描述。
创建人	创建Webhook的用户。
创建时间	创建Webhook的时间，支持排序。
操作	编辑、复制、发布、删除。