Вебхуки для відстеження активності | Support eSputnik

Дані користувача

Email

Омніканальність

Автоматизація

Відстеження подій та поведінки

Вебхуки для відстеження активності

Webhooks (укр. — вебхуки) — метод відстеження в режимі реального часу певних подій у системі eSputnik та сповіщення про них сторонніх URL.

В eSputnik є два способи для налаштування та використання вебхуків:

1. Додавання зовнішнього URL для аккаунту, щоб відслідковувати активності користувачів.
2. Налаштування кастомних запитів в сценаріях через спеціальний блок Webhook.

Вебхуки для відстежування активностей

Ця функціональність дозволяє в режимі реального часу отримувати інформацію про всі активності контактів. Дані надходитимуть регулярно на вказаний URL POST запитами, як описано нижче.

Для порівняння/альтернативи є метод API Get contacts activity. Він працює при надсиланні з вашого боку GET запитів, в яких можна вказувати інтервал часу (не більше 3 місяців) та параметри (email, статус тощо).

За допомогою вебхуків можна отримувати інформацію про події у всіх медіаканалах:

  • доставлено;
  • помилка доставлення;
  • прочитано;
  • одержувач перейшов за посиланням;
  • одержувач відписався від розсилок;
  • одержувач поскаржився на спам;
  • підписки, унікальні перегляди та конверсія для віджетів.

Як впровадити вебхуки?

Вам необхідно сконфігурувати на своєму сервері URL, на який ви бажаєте отримувати повідомлення — POST-запити у форматі JSON та обробляти дані щодо них.

Потім цей URL необхідно додати до налаштувань eSputnik. Для цього авторизуйтеся в системі, зайдіть до налаштувань акаунта, розділ «Лабораторія». Активуйте опцію «Webhooks» і вставте ваш URL у поле «Webhook адреса».

Контроль тригерів у eSputnik

Далі почнеться миттєва перевірка URL-адреси GET-запитом. Якщо раптом виникнуть помилки, то, можливо, на вашому боці спрацює блокування нашого запиту з різних причин. Про точну причину можна дізнатися за кодом помилки сервера на вашому боці.

Система перевірить доступність URL-адреси. Якщо все відбулося успішно, то налаштування завершене.

Після цього здійсніть будь-яку дію в акаунті. Наприклад, надішліть собі листа. Протягом кількох хвилин за вказаною адресою буде відправлений POST-запит з інформацією про останні активності. POST-запити відправлятимуться в форматі JSON при виникненні активності користувачів (відправлення email, відкривання повідомлення, перехід тощо).

Якщо webhook URL не повертає код відповіді HTTP 200, то спроба POST-запиту буде повторюватися із зростаючими інтервалами (1 хвилина, 2 хвилини, 4 хвилини, 8 хвилин і так до одного запиту на годину). Наступні запити будуть відкладені до успішного відправлення першого, а потім також відправлятимуться послідовно.

Можливі параметри

Параметр Тип Опис
activityDateTime string Дата й час, коли відбулася активність
activityStatus string
  • DELIVERED - повідомлення доставлене
  • UNDELIVERED - повідомлення не доставлене (у параметрі statusDescription описано причину)
  • READ - повідомлення прочитане
  • UNSUBSCRIBED - контакт відписався від розсилок
  • CLICKED - контакт переходив за посиланнями в повідомленні
  • SPAM - контакт поскаржився на спам
  • SUBSCRIPTION_CHANGED – контакт змінив категорію підписки
broadcastId int Ідентифікатор розсилки
clickEventLink string Містить посилання, за яким перейшов контакт (при статусі CLICKED)
contactId int Ідентифікатор контакту
email string Email контакту
externalCustomerId string Унікальний ідентифікатор контакту у системі клієнта
hardBounce bool

Це поле повертається, тільки якщо статус UNDELIVERED. Параметр сповіщає про наявність контакту в чорному списку.

  • false – не в чорному списку на момент відправлення повідомлення
  • true – у чорному списку на момент відправлення
iid string Службовий параметр
mediaType string Медіатип (SMS, Email, Web Push, Viber, Mobile Push, AppInbox, Widget, In-App, Telegram)
messageId int Ідентифікатор повідомлення
messageInstanceId int Ідентифікатор екземпляра повідомлення
messageName string Назва повідомлення (відсутнє значення для тестових повідомлень)
messageTag string Мітка повідомлення
mobilepush string Token підписника мобільного застосунку
sms string Номер телефону контакту
sourceEventId int Ідентифікатор події
sourceEventKey string Ключ типу події
sourceEventTypeId int Ідентифікатор типу події
sourceEventTypeKey string Значення ключа події
statusData   Масив із даними
statusDescription string Це поле повертається тільки у випадку статусу UNDELIVERED. Містить причину, з якої повідомлення не було доставлене. Це може бути відповідь сервера одержувача, відповідь системи про неможливість відправити повідомлення etc
subscripton   Масив із даними
subscriptons array of string Ключі категорій підписок
viber string Номер телефону контакту
viewMessageLink string Містить посилання на веб-версію повідомлення
webpush string Token підписника веб-повідомлень
workflowBlockId string Службовий параметр сценарія
workflowId int Ідентифікатор сценарія
workflowInstanceId int Ідентифікатор окремого запуску сценарію. Використовуйте його для угрупування розсилок у рамках запуску одного сценарію.

Нижче наведено тестові приклади вебхуків у вигляді масиву JSON з усіма можливими варіантами статусів. 

Для масових розсилок:

JSON
COPY
MORE

Для тригерних розсилок:

JSON
COPY
MORE

Практичне застосування вебхуків

Цей функціонал дозволяє отримувати в режимі реального часу інформацію про всі активності контакту без запитів інформації з вашого боку. Інформація надходитиме регулярно на вказаний URL POST-запитами, як описано вище.

Для порівняння/альтернативи існує метод API Get contacts activity.

Він працює при відправленні з вашого боку GET-запитів, у яких можна вказувати інтервал часу (не більше 3 місяців) і параметрів (email, статус тощо).

Документація: https://docs.esputnik.com/reference/contactactivity-1

Протестуйте на реальних розсилках

Залишилися питання?
Спеціалісти обов'язково нададуть відповідь та допоможуть вирішити вашу проблему!
Консультація в чаті
Готові до ваших запитань!
Написати в чат
Електронна пошта
Напишіть в службу підтримки eSputnik.
Надіслати email