Webhooks
Общее описание Webhooks
Webhook (рус. - вебхук) - метод отслеживания в реальном времени определенных событий в системе eSputnik и оповещения сторонних веб-приложений о них. Образно это можно представить как подписку на конкретные события в системе, например, отписка от рассылки. Вебхуками также называют запросы-уведомления, при помощи которых система передает определенные данные стороннему веб-клиенту в режиме реального времени без предварительного запроса от него.
События, которые можно получать используя вебхуки
- доставлено,
- ошибка доставки,
- прочитано,
- получатель перешел по ссылке,
- получатель отписался от рассылок,
- получатель пожаловался на спам.
Как внедрить вебхуки
- Вам необходимо сконфигурировать на своем сервере URL, на который вы хотите получать уведомления.
- Затем этот URL необходимо внести в настройки eSputnik. Для этого авторизируйтесь в системе, зайдите в настройки аккаунта, раздел “Лаборатория”. Активируйте опцию “Webhooks” и вставьте ваш URL в поле “Webhook адрес”.
|
Параметр |
Тип |
Описание |
|
contactId |
int |
Идентификатор контакта. |
|
|
string |
Email контакта. |
|
activityStatus |
string |
Статус активности DELIVERED - сообщение доставлено UNDELIVERED - сообщение не доставлено READ - сообщение прочитано UNSUBSCRIBED - контакт отписался от рассылок CLICKED - контакт переходил по ссылкам в сообщении SPAM - контакт пожаловался на спам |
|
messageId |
int |
Идентификатор сообщения. |
|
messageInstanceId |
int |
Идентификатор экземпляра сообщения. |
|
messageTag |
string |
Метка сообщения. |
|
activityDateTime |
string |
Дата и время, когда случилась активность. |
|
statusDescription |
string |
Это поле возвращается только в случае, если статус UNDELIVERED, Содержит причину, по которой сообщение не было доставлено. Это может быть ответ сервера получателя, ответ системы о невозможности отправить сообщение etc. |
|
viewMessageLink |
string |
Содержит ссылку на сообщение |
|
clickEventLink |
string |
Содержит ссылку по которой перешел контакт |
Практическое применение вебхуков
- для сегментации клиентской базы с учетом активности клиентов по рассылкам
- для аналитики комплексных рекламных кампаний, в которых одним из используемых каналов является eSputnik
- для создания резервных копий базы данных дополненных информацией из eSputnik.