Перейти к содержанию

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

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

Anchor link to

Эта интеграция позволяет настроить конечную точку вебхука для получения данных от Pushwoosh в реальном времени, в частности событий статуса email-сообщений, таких как «Письмо отправлено», «Письмо доставлено», «Письмо не доставлено», «Письмо открыто» и т. д.

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

Anchor link to

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

Глоссарий

Anchor link to

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

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

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

Anchor link to

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

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

Anchor link to

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

  1. В вашем аккаунте Pushwoosh перейдите в Настройки > Сторонние интеграции и найдите Интеграция с вебхуком. Нажмите Настроить.
  1. В открывшемся окне введите полный URL-адрес конечной точки вебхука и нажмите Применить.

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

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

Anchor link to

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

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

Anchor link to
Название поляТипОбязательноОписаниеПример
event_namestringДаНазвание события"Email Sent"
message_iduint64НетУникальный ID сообщения, связанного с событием.200XXXX3258
message_codestringДаКод сообщения, связанного с событием."B780-XXXXXX3C-XXXX0375"
campaign_iduint64НетУникальный ID кампании, связанной с событием.96XXXX
platformstringДаПлатформа устройства, связанная с событием (например, iOS, Android, Email)."Email"
application_codestringДаКод приложения, связанного с событием."3XXXX-XXXX1"
hwidstringДаИдентификатор устройства (HWID), связанный с событием."example@gmail.com"
user_idstringДаUser ID пользователя Pushwoosh, связанный с событием."15XXXX8"
payloadstringНетСодержимое, связанное с сообщением, зависит от платформы. Для событий Email здесь содержится тема письма. Для других платформ здесь может быть другое релевантное содержимое, специфичное для события (например, текст или заголовок сообщения)."Don't miss our summer sale!"
timestampint64ДаВремя, когда произошло событие, в формате временной метки UNIX.1723798222
journey_titlestringНетНазвание Путешествия (Journey), связанного с событием."Summer sale"
journey_point_titlestringНетНазвание конкретной точки в Путешествии (Journey), связанной с событием."5_summer sale_new"

Пример запроса

Anchor link to
{
"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"
}