Webhook管理

新建webhook

操作步骤：

1. 选择>管理中心>工作空间>所在工作空间>Webhook管理，进入管理页面。

2. 单击右上角新建webhook。

3. 在弹窗中配置参数，如下表所示。

   参数	说明
   webhook名称	输入webhook名称。
   鉴权方式	选择鉴权方式： 无：不进行鉴权。 密钥：通过验证密钥进行鉴权，需要在下方输入密钥。
   请求地址	输入要接收消息推送的接口地址，必须是以http或https开头的完整地址。 建议使用HTTPS协议，以提高信息传输的安全性。
   发送ID类型	选择允许发送的ID类型，可多选。但在创建任务时，每个任务仅可选择发送一种ID。 支持选择当前受众可用的所有ID类型。
   webhook参数	您可以定义webhook参数，在使用该webhook创建不同的营销任务时，可以灵活定义这些参数的值。例如：一方系统设置的发送内容为“在{address}进行折扣活动”，{address}}即为一个参数，在创建营销任务时，需要指定为具体内容。 参数名称 显示名称：显示在营销任务创建页面上的参数名称。 参数类型：参数的数据类型，支持字符型、数值型、文本型、日期型。 单击添加模版参数，可以增加一组webhook参数。
   是否开启回执设置	选择是否开启回执设置，使一方系统能够通过上报回执将发送结果返回Quick Audience，显示在营销任务详情页面，或用于自动化营销的结果多分支组件。 若开启，您需要设置： 数据回收周期：超过该周期后，Quick Audience将不再接收发送结果。 状态code、状态值：回执中，状态code为发送结果代码，如：200；状态值为对应的发送结果，如：成功。 状态code、状态值可能有多对，单击新增状态，可以增加一对。

4. 单击消息格式预览，下方将根据已配置的参数展示HTTP Post请求的消息体格式。详细说明，请参见webhook接入文档。

5. 单击确定，完成配置。

测试发送

使用webhook进行营销前，您需要测试发送，确保其可用性。

操作步骤：

1. 单击图标。

2. 在弹窗中选择要测试发送的ID类型，输入测试ID、webhook参数值。

   说明

   一次仅能测试一种ID类型。测试营销任务需要发送的ID类型即可。

   

3. 单击确定，系统将通过webhook调用一方系统向测试ID发送消息。

   弹窗将显示测试发送是否成功。

   • 测试发送成功：请检查一方系统是否收到了webhook请求，测试ID是否收到消息。若未收到，请单击弹窗中的下载日志，排查原因。

   • 测试发送失败：请单击弹窗中的下载日志，排查原因。

授权

管理员以外的空间成员，若需要使用webhook创建营销任务，必须先由管理员授予该webhook的使用权限，并加入带有“用户营销-私有化营销-webhook”权限的自定义角色。

授权操作步骤：

1. 单击>授权，进入授权页面，如下图所示。

2. 选择授权方式：支持按用户和按用户组。

   说明

   两种授权方式相互排斥，仅可选其中一种进行授权。若已按一种方式授权，再次授权时选择另一种方式，则使用旧授权方式的授权将解除，仅生效使用新授权方式的授权。

   下方显示已授权用户账号/用户组，以及授权有效期。

3. 解除授权：单击账号/用户组对应的移除，即可解除对该账号/用户组的授权，立即生效。

4. 授权：选择要授权的账号/用户组，可多选，设置有效期，单击确定完成授权。

关闭/开启

webhook创建后，默认为开启状态，此时可测试、使用webhook；若需要编辑、删除webhook，必须先关闭webhook。

通过右侧的开关，您可以关闭、开启webhook。

编辑

在关闭webhook后，您可以对其进行编辑。

单击图标，进入编辑界面，后续操作与创建时相同。

复制

单击>复制，进入新的配置页面，已默认填写与原webhook相同的配置项，支持修改，单击确定完成复制。

复制生成的新webhook，默认为关闭状态，需要手动开启，才能测试、使用。

删除

在关闭webhook后，若该webhook未被用于任何营销任务，您可以删除该webhook。

单击>删除，确认后即删除该webhook。

webhook接入文档

webhook接入开发包括以下几个方面，请参考我们给出的消息格式和样例进行开发。

{webhook配置的url}?timestamp=1631865523&nonce=2e6eceb5737b473284c930c8ef79090e

public String makeSignature(String key, String timestamp, String nonce) {
   String str = generateStr(key, timestamp, nonce);
    return HmacUtils.hmacSha256Hex(key, str.replaceAll("\\s+", ""));
} 

/**
 * 签名待处理的字符串拼接
 */
public static String generateStr(String key, String timestamp, String nonce){
    String[] array = new String[] { key, timestamp, nonce};
    StringBuffer sb = new StringBuffer();
    // 字符串排序
    Arrays.sort(array);
    for (int i = 0; i < 3; i++) {
        sb.append(array[i]);
    }
    return sb.toString();
}

[{
    "user_profile":{
        "target_type":"OPEN_ID",
        "target_id":"1917810"
    },
    "params":{
        "define_item1":"优惠券ID",
        "define_item2":"优惠券内容示例，用户所在的地址是北京"   //北京是变量${city}填入的变量值
    },
    "callback_params":{
        "task_id":"1234455sseeddedd1234455sseeddedd",
        "webhook_id":"13312313",
        "send_time":"1625037472000"
    }
}]

{
 "code":"OK",      //请求状态码：返回OK代表请求成功，必须为大写；返回其他为错误码，接入方自定义。
  "message":"",    //状态码描述，非必填。
  "requestId":""    //请求ID，接入方自定义。
}

http://${region域名}/restapi/thirdservice/webhook/receiveWebHookCallBack?timestamp=1631865523&nonce=2e6eceb5737b473284c930c8ef79090e

[{
    "msg_id":"236eceb5737b473284c930c8ef79090e",
    "status":"200",
    "cst_id":"1917810",
    "send_time":"1625037473000"
    "callback_params":{
        "task_id":"2e6eceb5737b473284c930c8ef79090e",
        "webhook_id":"13312313",
        "send_time":"1625037472000"
    }
}]