1.1 Webhook消息格式

Webhook消息格式

Webhook支持如下几类消息：自定义消息、客户事件、客户属性变更、客户身份变更和会员事件。下面分别对各种消息的格式一一做说明。

自定义消息

自定义消息在手动发送、自动流程和提交表单时发送的Webhook中会使用。Webhook发送的消息格式会按照用户定义的格式发送，同时会替换里面的变量。

示例:

自定义JSON消息体:

{
  "姓名":"${name!\"\"}",
  "公司":"Convertlab"
}

Webhook消息接收地址接收到的消息内容:

{
    "姓名": "DM Hub",
    "公司": "Convertlab",
    "MESSAGEID": "6f883839ec224526a1ecbb59ca8f5277"
}

JSON消息还会随消息携带一个MESSAGEID，用于方便定义问题。

自定义TEXT消息体:

  ${name!\"顾客\"}, 你好!

TEXT消息内容:

    顾客, 你好!

自定义消息支持的变量

除了可以在界面中插入的变量，如客户变量，会员变量等。自定义消息还支持如下变量：

tenantId: 发送消息的租户ID
customerId: 对应的客户ID
campaign: 对应的营销活动编码
webhookId: 对应的Webhook Id
batchId: 该次发送的批次号（不一定有）

自动流发送的Webhook还可以使用如下变量:

flowId: 自动流程ID
flowVersion: 自动流程版本号
flowStep: 自动流程的步骤ID

客户事件

对于订阅了客户事件的Webhook，在客户事件发生时，DM Hub会将事件的内容发送给消息接收地址。Webhook可以订阅系统事件和自定义客户事件。当Webhook订阅了多个客户事件时，多条事件会依次发送给接收地址，而不是一次性发送多条。下面以点击微信菜单事件为例来说明消息的格式。

示例：

事件类型：点击微信菜单事件
事件关键字：click_menu
消息内容:

{
  "MESSAGEID": "ce735894be7a4366a5ec905e2ec4b14c",
  "topic": "customerEvent",
  "data": {
    "event": {
      "createdDate": "2020-08-18T08:14:31.548Z",
      "type": "created"
    },
    "object": {
      "id": "784697835080734720",
      "tenantId": 1,
      "customerId": "577610832247089152",
      "channelType": "wechat",
      "channelAccount": "1234",
      "event": "click_menu",
      "targetId": "kdfb9nho734l6",
      "targetName": "会员福利",
      "date": "2020-08-18T08:14:29.285Z",
      "userId": "okY_5jvvwjyrGzEFrHgSCIJ96GgY",
      "identityType": "wechat",
      "identityValue": "okY_xxxj_openid",
      "lastUpdated": "2020-08-18T08:14:31.432Z"
    }
  }
}

字段说明:

字段	说明
MESSAGEID	本次发送的消息ID，用于调试
topic	本次消息发送的类型，客户事件的topic都为customerEvent
data	webhook的消息内容
data.event	事件的类型和发生的事件，对于客户事件Webhook消息，类型都是created
data.object	客户事件的内容，具体参照客户事件[客户事件]

客户属性变更

对于订阅了客户属性变更的Webhook，在客户属性发生变更时，DM Hub会将发生变更的属性内容发送给消息接收地址。Webhook可以订阅系统事件和自定义客户事件。下面以客户公司属性发生变更为例来说明消息的格式。

示例：

消息内容:

{
    "MESSAGEID": "ce735894be7a4366a5ec905e2ec4b14c",
    "data": {
        "event": {
            "createdDate": "2020-08-18T08:14:31.548Z",
            "type": "updated"
        },
        "object":{
            "customerId": "577610832247089152",
            "name": "张三",
            "company": "百度",
            "id": 1999
        } 
    },
    "topic": "customer"
}

字段说明:

字段	说明
MESSAGEID	本次发送的消息ID，用于调试
topic	本次消息发送的类型，客户属性变更的topic都为customer
data	webhook的消息内容
data.event	事件的类型和发生的事件，对于客户事件Webhook消息，类型可以是created,updated，deleted
data.object	客户属性的内容，具体参照查询客户

客户身份变更

对于订阅了客户身份变更的Webhook，在系统客户发生增删改变更时，DM Hub会将事件的客户内容发送给消息接收地址。

示例：

消息内容:

{
    "MESSAGEID": "ce735894be7a4366a5ec905e2ec4b14c",
    "data": {
        "event": {
            "createdDate": "2020-08-18T08:14:31.548Z",
            "type": "deleted"
        },
        "object":{
            "id": 2850786358,
            "version": 1,
            "type": "wechat-unionid",
            "value": "ombkt1FfCsqV91SQZ-p5-HfXqDVY",
            "name": "小情绪",
            "tenant_id": 4209,
            "date_created": "2020-08-19 07:23:15",
            "last_updated": "2020-08-19 07:23:15",
            "customer_id": 785396805977360400
        } 
    },
    "topic": "customerIdentity"
}

字段说明:

字段	说明
MESSAGEID	本次发送的消息ID，用于调试
topic	本次消息发送的类型，客户属性变更的topic都为customer
data	webhook的消息内容
data.event	事件的类型和发生的事件，对于客户身份变更Webhook消息，类型可以是created，deleted
data.object	客户身份相关信息
data.object.id	事件ID
data.object.version	版本号
data.object.type	客户来源类型
data.object.value	变更后的值
data.object.name	姓名
data.object.tenant_id	tenantId
data.object.date_created	创建时间
data.object.last_updated	更新时间
data.object.customer_id	客户ID
data.object.value_md5	value_md5

会员事件

对于订阅了会员事件的Webhook，在会员事件发生时，DM Hub会将事件的内容发送给消息接收地址。Webhook目前支持以下5种会员相关事件。

示例：

事件类型：会员等级升级事件
事件关键字：loyalty/membership_level_up
消息内容：

{
    "MESSAGEID": "4e7eed8aceef464db0a60205808dd726",
    "customerId": "785402304818944000",
    "date": "2020-08-19T07:34:15Z",
    "event": "loyalty/membership_level_up",
    "membershipId": "119857345",
    "newLevel": "LV1",
    "newLevelId": 3441,
    "oldLevel": "LV0",
    "oldLevelId": 3433,
    "tenantId": 306
}

字段说明:

字段	说明
MESSAGEID	本次发送的消息ID，用于调试
customerId	客户ID
tenantId	tenantId
event	事件关键字
membershipId	会员 ID
date	事件发生的时间
oldLevelId	原等级 ID
newLevelId	新等级 ID
oldLevel	原等级名称
newLevel	新等级名称

事件类型：会员等级降级事件
事件关键字：loyalty/membership_level_down
消息内容：

{
    "MESSAGEID": "4e7eed8aceef464db0a60205808dd726",
    "customerId": "785402304818944000",
    "date": "2020-08-19T07:34:15Z",
    "event": "loyalty/membership_level_down",
    "membershipId": "119857345",
    "newLevel": "LV1",
    "newLevelId": 3446,
    "oldLevel": "LV2",
    "oldLevelId": 3434,
    "tenantId": 306
}

字段说明:

字段	说明
MESSAGEID	本次发送的消息ID，用于调试
customerId	客户ID
tenantId	tenantId
event	事件关键字
membershipId	会员 ID
date	事件发生的时间
oldLevelId	原等级 ID
newLevelId	新等级 ID
oldLevel	原等级名称
newLevel	新等级名称

事件类型：系统发放优惠券事件
事件关键字：loyalty/loyalty_dispatch_coupon
消息内容：

{
    "batchId": "flow-446065_6_false@@14",
    "couponCode": "784637477225773056",
    "couponId": "eoaQZWQ2mdPL7G3eRhm2",
    "couponName": "【2020年8月】茶机300元优惠券",
    "customerId": "778129594954950656",
    "date": "2020-08-18T06:14:36Z",
    "endDate": "2020-08-31T15:59:59Z",
    "event": "loyalty/loyalty_dispatch_coupon",
    "membershipId": "117743425",
    "startDate": "2020-07-26T16:00:00Z",
    "tenantId": 1209
}

字段说明:

字段	说明
tenantId	tenantId
event	事件关键字
membershipId	会员 ID
date	事件发生的时间
couponId	优惠券 ID
couponName	优惠券名称
batchId	批次号
couponCode	优惠券 code（该客户的唯一 code）
startDate	起始有效日期
endDate	截止有效日期

事件类型：领取优惠券事件
事件关键字：loyalty/membership_draw_coupon
消息内容：

{
    "couponId": "0m_YTifBat76AfDCf0zX",
    "couponName": "Chubbsafes集宝保柜100元优惠券",
    "couponCode": "780350791910176800",
    "startDate": "2020-08-11T16:00:00Z",
    "endDate": "2020-09-10T15:59:59Z",
    "customerId": null,
    "membershipId": "117741857",
    "event": "loyalty/membership_draw_coupon",
    "tenantId": 1223,
    "date": "2020-08-12T08:17:43Z"
}

字段说明:

字段	说明
tenantId	tenantId
event	事件关键字
membershipId	会员 ID
date	事件发生的时间
couponId	优惠券 ID
couponName	优惠券名称
couponCode	优惠券 code（该客户的唯一 code）
startDate	起始有效日期
endDate	截止有效日期

事件类型：核销优惠券事件
事件关键字：loyalty/membership_redeem_coupon
消息内容：

{
    "couponId": "eoaQZWQ2mdPL7G3eRhm2",
    "couponName": "【2020年8月】茶机300元优惠券",
    "couponCode": "782694747738224640",
    "customerId": "782694697842884608",
    "membershipId": "118793137",
    "event": "loyalty/membership_redeem_coupon",
    "tenantId": 1209,
    "date": "2020-08-15T13:56:33Z"
}

字段说明:

字段	说明
tenantId	tenantId
event	事件关键字
membershipId	会员 ID
date	事件发生的时间
couponId	优惠券 ID
couponName	优惠券名称
couponCode	优惠券 code（该客户的唯一 code）