Webhook 集成

集成概述

此集成允许您设置一个 Webhook 端点，以从 Pushwoosh 接收实时数据，特别是电子邮件状态事件，例如电子邮件已发送、电子邮件已送达、电子邮件被退回、电子邮件已打开等。

集成类型

源：数据通过 Webhook 从 Pushwoosh 发送到您的系统。

术语表

Webhook 端点：一个服务器端 URL，用于接收来自 Pushwoosh 的 HTTP POST 请求。客户端可以指定确切的端口。

不带端口的示例：https://clientdomainname.com/webhook_endpoint
指定端口的示例：https://clientdomainname.com:8081/webhook_endpoint

同步实体

电子邮件状态事件，提供有关用户与您发送的消息互动的数据。

设置集成

要设置集成：

在您的 Pushwoosh 帐户中，转到 Settings > 3rd Party Integrations 并找到 Webhook Integration。点击 Configure。

在打开的窗口中，输入 Webhook 端点的完整 URL，然后点击 Apply。

成功配置后，您将开始收到来自 Pushwoosh 的请求。

如何验证集成是否正常工作

集成设置完成后，您将在指定的 Webhook 端点收到来自 Pushwoosh 的 HTTP POST 请求。

Webhook 请求体

Field name	Type	Required	Description	Example
event_name	string	Yes	事件的名称	`"Email Sent"`
message_id	uint64	No	与事件关联的消息的唯一 ID。	`200XXXX3258`
message_code	string	Yes	与事件关联的消息代码。	`"B780-XXXXXX3C-XXXX0375"`
campaign_id	uint64	No	与事件关联的营销活动的唯一 ID。	`96XXXX`
platform	string	Yes	与事件关联的设备平台（例如，iOS、Android、Email）。	`"Email"`
application_code	string	Yes	与事件关联的应用程序代码。	`"3XXXX-XXXX1"`
hwid	string	Yes	与事件关联的设备标识符 (HWID)。	`"example@gmail.com"`
user_id	string	Yes	与事件关联的 Pushwoosh User ID。	`"15XXXX8"`
payload	string	No	与消息相关的内容取决于平台。对于电子邮件事件，此字段包含电子邮件主题。对于其他平台，此字段可能包含与事件相关的不同内容（例如，消息内容或标题）。	`"Don't miss our summer sale!"`
timestamp	int64	Yes	事件发生的时间，采用 UNIX 时间戳格式。	`1723798222`
journey_title	string	No	与事件关联的 Journey 的标题。	`"Summer sale"`
journey_point_title	string	No	与事件关联的 Journey 中特定点的标题。	`"5_summer sale_new"`

请求示例

{
  "event_name": "Email Sent",
  "message_code": "B780-XXXXXX3C-XXXX0375",
  "campaign_id": 96XXXX,
  "platform": "Email",
  "payload": "Don't miss our summer sale!",
  "application_code": "3XXXX-XXXX1",
  "hwid": "example@gmail.com",
  "user_id": "15XXXX8",
  "timestamp": 1723798222,
  "journey_title": "Summer sale",
  "journey_point_title": "5_summer sale_promoemail"
}