Интеграция с веб-хуками

Обзор интеграции

Эта интеграция позволяет настроить конечную точку веб-хука (Webhook endpoint) для получения данных от Pushwoosh в реальном времени, в частности событий, связанных со статусом email-сообщений, таких как Email Sent, Email Delivered, Email Bounced, Email Opened и т. д.

Тип интеграции

Источник: данные отправляются из Pushwoosh в вашу систему через веб-хук.

Глоссарий

Конечная точка веб-хука (Webhook endpoint): URL на стороне сервера, который получает HTTP POST-запросы от Pushwoosh. Клиенты могут указать точный порт.

Пример без указания порта: https://clientdomainname.com/webhook_endpoint
Пример с указанием порта: https://clientdomainname.com:8081/webhook_endpoint

Синхронизируемые сущности

События, связанные со статусом email-сообщений, которые предоставляют данные о взаимодействии пользователей с отправленными вами сообщениями.

Настройка интеграции

Чтобы настроить интеграцию:

В своем аккаунте Pushwoosh перейдите в Settings > 3rd Party Integrations и найдите Webhook Integration. Нажмите Configure.

В открывшемся окне введите полный URL-адрес конечной точки веб-хука и нажмите Apply.

После успешной настройки вы начнете получать запросы от Pushwoosh.

Как проверить, что интеграция работает

После настройки интеграции вы будете получать HTTP POST-запросы от Pushwoosh на указанную конечную точку веб-хука.

Тело запроса веб-хука

Название поля	Тип	Обязательно	Описание	Пример
event_name	string	Да	Название события	`"Email Sent"`
message_id	uint64	Нет	Уникальный ID сообщения, связанного с событием.	`200XXXX3258`
message_code	string	Да	Код сообщения, связанного с событием.	`"B780-XXXXXX3C-XXXX0375"`
campaign_id	uint64	Нет	Уникальный ID кампании, связанной с событием.	`96XXXX`
platform	string	Да	Платформа устройства, связанная с событием (например, iOS, Android, Email).	`"Email"`
application_code	string	Да	Код приложения, связанного с событием.	`"3XXXX-XXXX1"`
hwid	string	Да	Идентификатор устройства (HWID), связанный с событием.	`"example@gmail.com"`
user_id	string	Да	User ID (идентификатор пользователя) Pushwoosh, связанный с событием.	`"15XXXX8"`
payload	string	Нет	Содержимое, связанное с сообщением, зависит от платформы. Для email-событий здесь содержится тема письма. Для других платформ это поле может содержать другой релевантный контент, специфичный для события (например, текст или заголовок сообщения).	`"Don't miss our summer sale!"`
timestamp	int64	Да	Время, когда произошло событие, в формате UNIX timestamp.	`1723798222`
journey_title	string	Нет	Название Journey, связанного с событием.	`"Summer sale"`
journey_point_title	string	Нет	Название конкретной точки в 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"
}