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

Требуется помощь разработчика

Для настройки интеграции вам потребуется помощь команды разработчиков. Пожалуйста, поделитесь с ними этим руководством.

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

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

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

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

Глоссарий

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

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

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

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

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

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

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

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

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

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

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

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

Имя поля	Тип	Обязательно	Описание	Пример
event_name	string	Да	Название события	"Email Sent"
message_id	uint64	Нет	Уникальный идентификатор сообщения, связанного с событием.	200XXXX3258
message_code	string	Да	Код сообщения, связанного с событием.	"B780-XXXXXX3C-XXXX0375"
campaign_id	uint64	Нет	Уникальный идентификатор кампании, связанной с событием.	96XXXX
platform	string	Да	Платформа устройства, связанная с событием (например, iOS, Android, Email).	"Email"
application_code	string	Да	Код Application, связанного с событием.	"3XXXX-XXXX1"
hwid	string	Да	Идентификатор устройства (HWID), связанный с событием.	"example@gmail.com"
user_id	string	Да	User ID Wavesend, связанный с событием.	"15XXXX8"
payload	string	Нет	Содержимое, связанное с сообщением, зависит от платформы. Для Email-событий это поле содержит тему письма. Для других платформ оно может включать другой релевантный контент, специфичный для события (например, текст или заголовок сообщения).	"Не пропустите нашу летнюю распродажу!"
timestamp	int64	Да	Время, когда произошло событие, в формате UNIX timestamp.	1723798222
journey_title	string	Нет	Название Journey, связанного с событием.	"Летняя распродажа"
journey_point_title	string	Нет	Название конкретной точки в Journey, связанной с событием.	"5_summer sale_new"

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

{
  "event_name": "Email Sent",
  "message_code": "B780-XXXXXX3C-XXXX0375",
  "campaign_id": 96XXXX,
  "platform": "Email",
  "payload": "Не пропустите нашу летнюю распродажу!",
  "application_code": "3XXXX-XXXX1",
  "hwid": "example@gmail.com",
  "user_id": "15XXXX8",
  "timestamp": 1723798222,
  "journey_title": "Летняя распродажа",
  "journey_point_title": "5_summer sale_promoemail"
}