Webhook通道--增长营销平台-火山引擎

文档中心

立即注册

导航

Webhook通道

最近更新时间：2025.11.18 19:53:51首次发布时间：2025.11.18 19:28:46

创建的 Webhook 通道将在「营销配置 - 通道配置 - Webhook 通道」进行统一管理。

前提条件

开通新建Webhook通道的权限，具体操作请参见权限设置。

功能说明

新建 Webhook

登录GMP控制台，选择营销配置 - 通道配置 - Webhook通道，点击新建Webhook，填写相关信息后，点击确定。
Webhook 对接步骤分为基础信息配置、外接模板配置、Webhook 请求响应配置、回执配置。
说明
若有 Webhook 通道对接需要联系火山引擎项目经理。
点击配合测试，可以针对该通道进行测试发送，用于通道的调试。

更新配置

需关闭通道后才能进行更新配置。支持编辑 Webhook 名称，消息接收地址、外接消息模板、鉴权方式、自定义返回码、QPS 上限、发送目标 ID、接口发送方式等信息。

频控设置

可以设置该通道的发送频控。使用该通道进行的触达都会过通道频控，如勾选多项，则需要满足所有条件。

目前支持天级、周级、月级的频控。
如果设置了勿扰策略，则使用该通道进行的触达都会实行通道勿扰。
触达任务、流程画布、流程画布中的策略器也可以进行单独的勿扰设置，如同时设置了勿扰，则多个勿扰条件均需满足。

黑白名单配置

通过该功能可以针对通道进行黑白名单管控。

管控的类型有 3 种：通道触达范围黑名单、通道频控白名单、通道触达范围白名单。

通道触达范围黑名单：该能力可以支持在该通道进行实际发送时，如果用户 ID 在黑名单分群当中，则不会进行发送。如果不选择则代表不做限制。
通道频控白名单：该能力在该通道进行实际发送时，在分群中的用户 ID 将不会受到通道频控管控。
通道触达范围白名单：在该通道进行实际发送时，在实际发送时，只会针对在这个分群里的用户进行发送，其他用户均不会被发送。

设置黑白名单的方式有 3 种，分别是通过指定**「分群」设置**、指定「标签」设置、指定「ID」设置。

① 通过「分群」设置
使用该功能需要购买 VeCDP，若未购买该模块，暂不支持该能力，可忽略本章节。
若已购买 VeCDP，则可按以下步骤操作进行设置。

步骤	详细说明
选择设置黑白名单	勾选需要设置的黑白名单类型，选择分群包的 ID 类型。
选择「分群」	通过标签与行为圈选或已有分群，配置黑白名单的分群，
生效分群	点击「生效」，使得该分群完成系统导入动作，正式生效。

② 通过「标签」设置
使用该功能需要购买 VeCDP，若未购买该模块，暂不支持该能力，可忽略本章节。
若已购买 VeCDP，则可按以下步骤操作进行设置。

步骤	详细说明
选择设置黑白名单	勾选需要设置的黑白名单类型。
设置「标签」	选择对应的标签，填写标签值信息，如果有多个标签，可以点击「添加通道触达范围黑名单标签」。

③ 通过「ID」设置
使用该功能，可以直接填写 ID 值信息用于黑白名单的管控。

步骤	详细说明
选择设置黑白名单	勾选需要设置的黑白名单类型。
填写 ID	填写 ID 值，此处填写的 ID 类型与通道的「发送目标 ID」是一致的。如通道的发送目标 ID 是 phoneid，则此处填写的 ID 值也应该是 phoneid 类型。ID 可以填写多个，多个名单用回车进行区分，填写的 ID 值建议在 20 个以内。

删除通道

只有被关闭的通道才可以进行删除。删除后的通道，后续将无法创建该通道的任务，请谨慎删除。

预置指标配置

对于「自定义 Webhook 类型」，如果该通道的回执指标无法通过「送达量、点击量」来进行统计（如外呼通道需要展示「外呼量、外呼率」指标），则可以使用本功能进行指标配置。
若有指标配置需求需要联系火山项目经理或客户成功经理。具体配置步骤如下：

① 配置回执指标。

选择「通道管理-Webhook-Webhook 回执配置」。

点击新增配置，配置相关参数

字段	字段含义及用途
配置名称	自主填写，该字段用于区分不同的回执配置
成功/失败到达配置	该回执对应数据分析的「送达量」指标、其他自定义回执配置：在「成功到达配置」里需要选择此项。该选择代表该回执状态码与 GMP 的指标的对应关系，如果该指标是对应「送达量」，则可选择「该回执对应数据分析的「送达量」指标」，如果是其他的指标，则可以选择「其他自定义回执配置」。 jsonpath：该回执所在的路径，以及对应的匹配关系。 Message：代表该回执指标的名称，可以自行定义，如外呼量、已读量。该指标名称可以用来配置 Webhook 通道的数据分析。该指标配置后不会立即在数据分析页面展示，还需要完成后续步骤才会展示对应的指标数据。

字段

字段含义及用途

配置名称

自主填写，该字段用于区分不同的回执配置

成功/失败到达配置

该回执对应数据分析的「送达量」指标、其他自定义回执配置：在「成功到达配置」里需要选择此项。该选择代表该回执状态码与 GMP 的指标的对应关系，如果该指标是对应「送达量」，则可选择「该回执对应数据分析的「送达量」指标」，如果是其他的指标，则可以选择「其他自定义回执配置」。
jsonpath：该回执所在的路径，以及对应的匹配关系。
Message：代表该回执指标的名称，可以自行定义，如外呼量、已读量。该指标名称可以用来配置 Webhook 通道的数据分析。该指标配置后不会立即在数据分析页面展示，还需要完成后续步骤才会展示对应的指标数据。

② Webhook 通道选择回执。
在 Webhook 通道配置的「回执配置」里，可以选择上一步完成的的「Webhook 配置」。

③ 进行指标配置。
在 Webhook 通道卡片点击「...」，选择「预置指标配置」，则可以进入「配置入口」。

字段	字段含义及用途
设置自定义指标	该通道在「Webhook 回执」配置的指标会默认带入，不需要额外配置。如果有组合指标（如外呼率）则可以在此处进行手动配置，如下图所示。
设置详细数据表格	发送链路相关的指标无法自行修改，回执指标可以在本功能进行配置。设置详细数据表格指标表格有两列：可选指标、已选指标。可选指标包含了在「Webhook 回执」配置的指标及在本页面配置的「自定义指标」配置的指标，选择指标后该指标将会展示在数据分析中，可以进行手动拖拽排序，该列的指标排序将决定了在数据分析页面展示的详细数据的指标排序。
设置漏斗指标	发送链路相关的漏斗指标无法自行修改，回执的漏斗指标可以在本功能进行配置。设置漏斗指标有两列，左侧列代表在漏斗里每层展示的指标；右侧列代表在漏斗每层中间，需要展示的「过滤原因」，漏斗里每层的过滤原因指「上一层」到「本层」之间的过滤原因。

字段

字段含义及用途

设置自定义指标

该通道在「Webhook 回执」配置的指标会默认带入，不需要额外配置。如果有组合指标（如外呼率）则可以在此处进行手动配置，如下图所示。

设置详细数据表格

发送链路相关的指标无法自行修改，回执指标可以在本功能进行配置。

设置详细数据表格指标表格有两列：可选指标、已选指标。可选指标包含了在「Webhook 回执」配置的指标及在本页面配置的「自定义指标」配置的指标，选择指标后该指标将会展示在数据分析中，可以进行手动拖拽排序，该列的指标排序将决定了在数据分析页面展示的详细数据的指标排序。

设置漏斗指标

发送链路相关的漏斗指标无法自行修改，回执的漏斗指标可以在本功能进行配置。

设置漏斗指标有两列，左侧列代表在漏斗里每层展示的指标；右侧列代表在漏斗每层中间，需要展示的「过滤原因」，漏斗里每层的过滤原因指「上一层」到「本层」之间的过滤原因。

SaaS Webhook 回执配置时独立 API 地址域名

SaaS 环境接口域名： gmp-saas-api.console.volcengine.com
完整请求地址：https://gmp-saas-api.console.volcengine.com