Webhook 推送

更新时间：2023-06-03 09:00

概述

平台提供的 Webhook 功能可以在平台处理邮件事件时推送对应的事件数据，这意味着您可以近乎实时地接收数据，非常适合日志记录或与监控系统集成。

由于 Webhook 推送将数据传送到您的系统，因此它也非常适合备份和存储事件数据，以满足您自己的数据访问和保留需求。

邮件事件类型

Webhook 能够推送的邮件事件类型分为两类：投递结果和互动事件

  • 已送达、退信、过滤 等投递结果事件可以帮助您了解，邮件是否成功投递给客户。
  • 打开、点击、退订、投诉 等互动事件可帮助您了解，邮件送达后用户是否正在阅读您的邮件并与之互动。

这两种类型的事件都很重要，平台允许您配置 Webhook 配置，您可以配置默认的推送URL，也可以根据发送方配置单独的URL。

Webhook数据包结构说明

  1. 数据包是采取json格式推送；
  2. 单次推送的数据包中会含有多个事件消息，最多包含1000个事件消息；
  3. 每个事件消息代表一个事件，由若干个字段组成，传递该事件的相关信息；
  4. 推送请求的默认字符集为UTF-8；
  5. 样例数据包如下：
POST /easeyewebhookreceive/receive.aspx?id=9787435 HTTP/1.1
content-type: application/json;charset=UTF-8
User-Agent: YiyeWebhooks
Host: www.yiyetest.com
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Connection: keep-alive
Content-Length: 1482

[{
    "Email": "demo1@lsh.com",
    "EventCode": "Delivered",
    "EventType": "3",
    "MailSeqId": 2505070900222412710,
    "ReceiveServer": "lsh-com.mail.protection.outlook.com[52.101.157.80]:25",
    "SenderEmail": "access_log@e-mail.contact.demo.com",
    "SentMailListName": "||",
    "SubmitDateTimeV2": "2025-05-07 09:00:22",
    "TriggeredDateTimeV2": "2025-05-07 09:00:26",
    "UniqueMsgID": "a75c3697-2ade-11f0-96fa-79c1da7ff337"
},
{
    "BrowserType": "Browser Edge",
    "DeliveredTimeV2": "2025-03-06 15:32:48",
    "Email": "hao.wang@demo2.com",
    "EventCode": "Clicked",
    "EventType": "3",
    "IP": "58.214.47.61",
    "Link": "https://pv.companies.com/exhLogin?locale=zh-CN",
    "MailSeqId": 2503061532475081710,
    "Platform": "Desktop Windows NT >=10",
    "SentMailListName": "||",
    "SubmitDateTimeV2": "2025-03-06 15:32:47",
    "Title": "",
    "TriggeredDateTimeV2": "2025-05-06 16:21:51",
    "UA": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/135.0.0.0 Safari/537.36 Edg/135.0.0.0",
    "UniqueMsgID": "234543534543"
}]

Webhook事件说明

Dropped事件

事件说明：由于各种原因（具体请参考Reason中说明），导致该邮件没有发送；

属性名类型说明
EventCodestring"Dropped"
Emailstring接收方Email
EventTypestring邮件的类型，
3：事务类邮件；
5：营销类邮件；
Reasonstring未发送原因：
110：硬退过滤，历史上判定为无效地址而过滤；
111：发送策略过滤，按照策略要求被过滤的用户；
112：过期，在有效期内未能投递完毕；
210：退订过滤，历史上判定为退订用户而过滤；
SenderEmailstring发送方
SentMailListNamestring邮件提交时设置的category、campaign，以“||”连接，
样例：bill||bill_202304
TriggeredDateTimeV2string事件产生的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
UniqueMsgIDstring邮件提交时设置的唯一标示

Dropped样例：

   {
       "EventCode":"Dropped",
       "Email":"test@test.easeye.net",
       "EventType":"3",
       "Reason":"112",
       "SenderEmail":"service@trigger.easeye.com",
       "SentMailListName":"bill||bill_202304",
       "TriggeredDateTimeV2":"2023-10-31 13:54:31",
       "UniqueMsgID":"23230232329"
   }

Bounced事件

事件说明：由于各种原因（具体请参考Reason中说明），导致该邮件发送失败；

属性名类型说明
EventCodestring"Bounced"
Emailstring接收方Email
EventTypestring邮件的类型，
3：事务类邮件；
5：营销类邮件；
Reasonstring未发送原因：
100：硬退，本次投递过程中投递失败，原因是因为该地址是无效地址；
101：软退，本次投递过程中投递失败，原因是接收方服务器无法链接成功或者拒信（邮箱已满，或者设置了黑名单，或者判定为垃圾邮件；
SenderEmailstring发送方
SentMailListNamestring邮件提交时设置的category、campaign，以“||”连接，
样例：bill||bill_202304
SubmitDateTimeV2string邮件提交发送的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
TriggeredDateTimeV2string事件产生的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
UniqueMsgIDstring邮件提交时设置的唯一标示
FailedCausestring投递失败的原因，需要进行base64解码

Bounced样例：

   {
       "EventCode":"Bounced",
       "Email":"test@test.easeye.net",
       "EventType":"3",
       "Reason":"100",
       "SenderEmail":"service@trigger.easeye.com",
       "SentMailListName":"",
       "SubmitDateTimeV2":"2023-10-31 13:54:31",
       "TriggeredDateTimeV2":"2023-10-31 13:54:31",
       "FailedCause":"Cjx0ZXN0QHRlc3QuZWFzZXllLm5ldD46IGhvc3QgdGVzdC5lYXNleWUubmV0WzEuMS4xLjFdIHNhaWQ6IDU1NCBJbnZhbGlkCiAgICByZWNpcGllbnQgKGluIHJlcGx5IHRvIFJDUFQgVE8gY29tbWFuZCkKCgo=",
       "UniqueMsgID":"892032348"
   }

Delivered事件

事件说明：已送达,邮件已投递到联系人邮箱。

属性名类型说明
EventCodestring"Delivered"
Emailstring接收方Email
EventTypestring邮件的类型，
3：事务类邮件；
5：营销类邮件；
SenderEmailstring发送方
SentMailListNamestring邮件提交时设置的category、campaign，以“||”连接，
样例：bill||bill_202304
SubmitDateTimeV2string邮件提交发送的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
TriggeredDateTimeV2string事件产生的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
UniqueMsgIDstring邮件提交时设置的唯一标示
ReceiveServerstring接收该信件的邮件服务器

Delivered样例：

   {
       "EventCode":"Delivered",
       "Email":"test@test.easeye.net",
       "EventType":"5",
       "ReceiveServer":"test.easeye.net[1.1.1.1]:25",
       "SenderEmail":"service@trigger.easeye.com",
       "SentMailListName":"",
       "SubmitDateTimeV2":"2023-10-31 13:54:31",
       "TriggeredDateTimeV2":"2023-10-31 13:54:31",
       "UniqueMsgID":"892052719"
   }

Opened事件

事件说明：联系人打开了邮件。每次打开都会产生一个此类事件消息；

属性名类型说明
EventCodestring"Opened"
Emailstring接收方Email
EventTypestring邮件的类型，
3：事务类邮件；
5：营销类邮件；
SentMailListNamestring邮件提交时设置的category、campaign，以“||”连接，
样例：bill||bill_202304
SubmitDateTimeV2string邮件提交发送的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
DeliveredTimeV2string邮件投递成功的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
TriggeredDateTimeV2string事件产生的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
UniqueMsgIDstring邮件提交时设置的唯一标示
IPstring事件发生时的客户端IP；
Platformstring事件发生时的客户端操作系统；
BrowserTypestring事件发生时的客户端软件名称；
UAstring事件发生时的客户端标识（UserAgent）；

Opened样例：

   {
       "EventCode":"Opened",
       "BrowserType":"",
       "DeliveredTimeV2":"2023-10-31 13:54:31",
       "Email":"test@test.easeye.net",
       "EventType":"3",
       "IP":"1.1.1.1",
       "Platform":"",
       "SentMailListName":"",
       "SubmitDateTimeV2":"2023-10-31 13:54:31",
       "TriggeredDateTimeV2":"2023-10-31 13:54:31",
       "UA":"Mozilla\/5.0 (Windows NT 6.3; WOW64) AppleWebKit\/537.36 (KHTML,like Gecko) Chrome\/45.0.2454.101 Safari\/537.36",
       "UniqueMsgID":"1809631"
   }

Clicked事件

事件说明：联系人点击了邮件内的某个链接(开启链接跟踪才会产生此数据)。每次点击都会产生一个此类事件消息。

属性名类型说明
EventCodestring"Clicked"
Emailstring接收方Email
EventTypestring邮件的类型，
3：事务类邮件；
5：营销类邮件；
SentMailListNamestring邮件提交时设置的category、campaign，以“||”连接，
样例：bill||bill_202304
SubmitDateTimeV2string邮件提交发送的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
DeliveredTimeV2string邮件投递成功的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
TriggeredDateTimeV2string事件产生的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
UniqueMsgIDstring邮件提交时设置的唯一标示
IPstring事件发生时的客户端IP；
Platformstring事件发生时的客户端操作系统；
BrowserTypestring事件发生时的客户端软件名称；
UAstring事件发生时的客户端标识（UserAgent）；
Linkstring邮件中被点击链接的URL；

Clicked样例：

   {
       "EventCode":"Clicked",
       "BrowserType":"Mobile Safari",
       "DeliveredTimeV2":"2023-10-31 13:54:31",
       "Email":"test@test.easeye.net",
       "EventType":"3",
       "IP":"1.1.1.1",
       "Link":"https:\/\/www.baidu.com\/def\/index.htm?ab=0&cd=ef",
       "Platform":"iOS",
       "SentMailListName":"",
       "SubmitDateTimeV2":"2023-10-31 13:54:31",
       "TriggeredDateTimeV2":"2023-10-31 13:54:31",
       "UA":"Mozilla\/5.0 (iPhone; CPU iPhone OS 10_2 like Mac OS X) AppleWebKit\/602.3.12 (KHTML,like Gecko) Mobile\/14C92 (4347662848)",
       "UniqueMsgID":"5611974"
   }

Unsubscribed事件

事件说明：联系人要求退订，不再接收营销邮件。

属性名类型说明
EventCodestring"Unsubscribed"
Emailstring接收方Email
EventTypestring邮件的类型，
3：事务类邮件；
5：营销类邮件；
SentMailListNamestring邮件提交时设置的category、campaign，以“||”连接，
样例：bill||bill_202304
TriggeredDateTimeV2string事件产生的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
UniqueMsgIDstring邮件提交时设置的唯一标示

Unsubscribed样例：

   {
       "EventCode":"Unsubscribed",
       "Email":"test@test.easeye.net",
       "EventType":"3",
       "SentMailListName":"",
       "TriggeredDateTimeV2":"2023-10-31 13:54:31",
       "UniqueMsgID":"1795046"
   }

SpamReport事件

事件说明：垃圾邮件投诉，联系人向ESP举报此邮件是垃圾邮件。

属性名类型说明
EventCodestring"SpamReport"
Emailstring接收方Email
EventTypestring邮件的类型，
3：事务类邮件；
5：营销类邮件；
SenderEmailstring发送方
SentMailListNamestring邮件提交时设置的category、campaign，以“||”连接，
样例：bill||bill_202304
TriggeredDateTimeV2string事件产生的时间，格式为yyyy-MM-dd HH:mm:ss，
样例：2023-10-31 13:54:31
UniqueMsgIDstring邮件提交时设置的唯一标示

SpamReport样例：

   {
       "EventCode":"SpamReport",
       "Email":"test@test.easeye.net",
       "EventType":"5",
       "SenderEmail":"service@trigger.easeye.com",
       "SentMailListName":"",
       "TriggeredDateTimeV2":"2023-10-31 13:54:31",
       "UniqueMsgID":"891025625"
   }