# Webhook

**1、Webhook 功能性介绍**

对于已经有建设自己的 CRM 系统的客户，CRM 中已经可以发送短信、Push， 只需要使用 GIO 的分群和事件触发的能力，用 Webhook 是一个比较灵活的解决方 案，用户只需要在运营平台的 Webhook 配置中完成前面此类人群规则的传递，信息发送的动作由客户自己来完成。

运营平台 Webhook 功能支持将分群信息(用户属性)发送到自己的内部系统 (push、发券系统、短信、邮件系统等)。同时，也支持将信息发送到自己的后 台，例如当用户发生了某些行为后若干次数后，客户可以在后台增加某个用户的 会员积分等。

1.1 对接 Push

运营平台支持第和客户的三方 Push 对接。通过发送请求到客户内部系统 ，客户内部系统再到三方 Push 即可实现对接第三方 Push 平台功能。

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnTgz_ks9BG6zUIJDB%2Fimage.png?alt=media\&token=6c66fbc0-e2ef-4b9b-8106-1ea3c67d19b9)

1.2 对接邮件/短信

若用户希望针对不同分群用户发送不同的定制化短信/邮件时，可通过 webhook 配置功能实现分客群、自动触发的短信发送管理。在“webhook 配置-请求地址”位置设置短信/邮件接口地址，填写模板参数。最后在创建 webhook 活动中进行邮件内容文案的设置，通过发送请求到客户内部系统 ，客户内部系统再到三方短信/邮件平台实现对接三方短信/邮件平台。

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnoPiRnfgnT_wJUz2J%2Fimage.png?alt=media\&token=273770d2-0d73-4a82-9e60-d2b6fffb3b9d)

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnoUK5WOwpfDSwlmQZ%2Fimage.png?alt=media\&token=7ff3aa72-1072-436d-a9e8-20f661808497)

&#x20; 短信文本可通过上述步骤中的参数进行设置。



1.3 对接发券

若用户拥有自建的优惠券系统，但是不支持圈选指定用户发券的功能，可通 过 webhook 配置功能实现通过自建优惠券系统发券的目标。在“webhook 配置- 请求地址”位置设置自建发券系统的接口地址，即可实现发券功能。

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnoZaxFvcaadszhy-e%2Fimage.png?alt=media\&token=35bac9f3-31ae-4f02-ab39-71325d3ab7a4)

同时，也支持针对不同群组创建对应的 webhook 活动

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnoc8z7Hd2fLpayZ8z%2Fimage.png?alt=media\&token=2eb4cde8-a12c-410c-832b-9af80de0d50a)



**2、webhook 配置说明&应用实例**

2.1 配置新的 webhook 通道

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnostZFWbuWxF40ddo%2Fimage.png?alt=media\&token=6230f208-55f3-4f26-b601-f6f99ad201fe)

(1)点击智能运营

(2)点击产品配置

(3)做常规配置中，选择 webhook 配置

(4)点击新建 webhook 通道

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnpK618QADne6PAnXS%2Fimage.png?alt=media\&token=cb7ccac9-dacd-4752-b4b4-f245ddac637e)

(5) 确定 webhook 通道名称（客户内部统一即可）

(6)确定请求地址（即客户开放给 gio 的调用接口）

(7)确定鉴权方式（可选“密钥”、“Basic Authentication”、“无”）

(8)用户属性（支持登陆用户/访问用户两种用户类型，需要在 gio 的数   据平台中维护和管理，默认值是作为数据缺失时的默认显示）

(9)模板参数（gio 不做任何判断，完全由客户的研发工程师根据客户自身系统的入参要求设定，默认值是作为数据缺失时的默认显示）

\--用户属性和模板参数最多支持设置 **10** 个

(10)测试效果（在上述5～6内容填写完毕后，可以进行测试，目的是确认 webhook 通道建立成功，与客户系统的交互正常可用）



2.2 建立 webhook 运营活动

当 webhook 通道建立完成后，就可以进行相对应的运营活动配置

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnpP3kQI7YeMdArANx%2Fimage.png?alt=media\&token=3bdee0aa-456b-4afd-b59e-c27bc53af962)

（1）点击运营活动

（2）选择 webhook

（3）点击新建 webhook

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnpSX4A7X1-F-OkDt3%2Fimage.png?alt=media\&token=56136021-892e-425a-ac08-a17f5dc76fe9)

（4）选择用户分群

（5）选择 webhook 通道

（6）选择触发类型![](blob:https://growingio.atlassian.net/ef874264-b69b-4f16-ac08-fbed535732b4#media-blob-url=true\&id=a3f4c5c3-2909-4663-885d-56b82f13d0a7\&collection=contentId-1470825243\&contextId=1470825243\&mimeType=image%2Fpng\&name=image-20200715-030531.png\&size=139016\&width=834\&height=549)

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnpW18iR08oI1K7bAJ%2Fimage.png?alt=media\&token=489e5672-edcc-4ad2-a8ee-469b73daa591)

（7）模板内容填写

（8）发送时间设置



**2.3 应用实例**

【故事1】

白鸽公司是一家会员制电商公司，拥有自建的优惠券系统，但是不支持圈选指定用户发券的功能，同时对接了 GIO 的 webhook 功能。

运营人员小雪现在要上线一个运营任务：针对公司昨日有加入购物车动作但还未下单的黄金vip等级会员（用户分群），每人发一张面值 100 元的优惠券（模板参数）

**A. webhook 通道参数配置如下**![](blob:https://growingio.atlassian.net/b94d1b70-84aa-4ffc-b076-bf59fc4402f5#media-blob-url=true\&id=89418424-c5d6-460d-b6ce-87664d5ad93c\&collection=contentId-1470825243\&contextId=1470825243\&mimeType=image%2Fpng\&name=image-20200715-031151.png\&size=185180\&width=1279\&height=633)

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnpZbZHLUA_hYVxlH9%2Fimage.png?alt=media\&token=7be5e942-bd16-45e1-b8a7-3d4f00756acd)

* webhook 通道名称：客户自己定，从客户视角，这个 webhook 通道是对接自建的优惠券系统，所以可以叫做“白鸽卡券中心”
* 请求地址：客户自建的发券系统提供给 gio 的接口地址
* 鉴权方式：如果选择鉴权就设置密钥
* 用户属性：不需要设置，可在配置 webhook 活动时通过客群选择时选择
* 模板参数：在这个故事中，webhook 是调客户自建的发券系统，只需要传券的面值金额即可，所以参数设定可以如下：

&#x20;_参数名称：amount_

&#x20;_显示名称：券面值_

&#x20;_参数类型：整数_

&#x20;_默认值：-_

* 测试成功后保存即可



**B. 创建对应的 webhook 活动**

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnpc4PaJvmYM149IA3%2Fimage.png?alt=media\&token=b30e2e17-eb17-4f29-8e41-3c3d8db26605)

* 选择客群
* 选择刚创建的“白鸽卡券中心”通道
* 触发设置：一次性
* 模板参数：在故事1中就是优惠券的金额，100 元（这里也可以点击测试效果，验证功能畅通）

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnpwZecnaeH60jNMC_%2Fimage.png?alt=media\&token=f289a6fb-3677-4054-b84a-5bd12355af79)

* 设置发送时间
* 上线/保存草稿

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnpiAyfwVShXX7cBtt%2Fimage.png?alt=media\&token=9d184965-a11d-433b-88d3-cd746e166d01)

* 上线后可见



【故事2】

运营人员小雪现在要上线一个运营任务：针对公司昨日有加入购物车动作但还未下单的黄金vip等级会员（用户分群），再通过用户 id（用户属性），白鸽内部自行计算历史交易额大于 5000 元的用户，这些用户每人发一张面值 100 元的优惠券（模板参数）

那么用户属性参数可以配置如下：

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnq0AWHax0UIGJ4Anv%2Fimage.png?alt=media\&token=2b0bc812-c34b-4706-ac5b-925a154f0143)

&#x20;_**参数名称：userid**_

&#x20;_**用户属性：用户登陆id**_

&#x20;_**默认值：-**_



【故事3】

白鸽公司是一家会员制电商公司，对接了第三方短信通道，同时对接了 GIO 的 webhook 功能。

运营人员小雪现在要上线一个运营任务：针对公司黄金vip等级会员用户，在其生日当天（用户分群），每人发一条祝福短信，并且短信文案为“亲爱的xxx先生/女士（用户属性），在这个属于您的精彩的日子，白鸽祝您生日快乐！“（模板参数）

这里只讲模板参数的设置，在这个故事中，不再是对接自建的券系统，而是对接客户的短信通道。具体参数设置如下：![](blob:https://growingio.atlassian.net/498d503a-5cea-49cc-8433-dd63c734393e#media-blob-url=true\&id=1c46efe8-2c5f-4abe-a6e2-328e5459d68e\&collection=contentId-1470825243\&contextId=1470825243\&mimeType=image%2Fpng\&name=image-20200715-031346.png\&size=187643\&width=1271\&height=628)

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnq3XFH34aPxtbcZDl%2Fimage.png?alt=media\&token=fa48bd68-91f7-4545-b158-fb9a996388bb)

&#x20;_**参数名称：message**_

&#x20;_**显示名称：短信**_

&#x20;_**参数类型：文本**_

&#x20;_**默认值：-**_

在创建 webhook 活动时，短信文本可设置

![](https://348272635-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lpwgem-x8KzhBglybzw%2F-MDnSQDzpt6wP-S4GkfP%2F-MDnq7d-snSgpBpSFkAA%2Fimage.png?alt=media\&token=744249c9-2740-494b-a0e4-698529ac2130)
