Webhooks

Общее описание Webhooks

Webhook (рус. - вебхук) - метод отслеживания в реальном времени определенных событий в системе eSputnik и оповещения сторонних веб-приложений о них. Образно это можно представить как подписку на конкретные события в системе, например, отписка от рассылки. Вебхуками также называют запросы-уведомления, при помощи которых система передает определенные данные стороннему веб-клиенту в режиме реального времени без предварительного запроса от него.

 

События, которые можно получать используя вебхуки

На сегодняшний день при помощи вебхуков можно получать изменения статуса письма:
  • доставлено, 
  • ошибка доставки, 
  • прочитано, 
  • получатель перешел по ссылке,
  • получатель отписался от рассылок,
  • получатель пожаловался на спам.

Как внедрить вебхуки

  1. Вам необходимо сконфигурировать на своем сервере URL, на который вы хотите получать уведомления. 
  2. Затем этот URL необходимо внести в настройки eSputnik. Для этого авторизируйтесь в системе, зайдите в настройки аккаунта, раздел “Лаборатория”. Активируйте опцию “Webhooks” и вставьте ваш URL в поле “Webhook адрес”.
На этом настройка завершена.
 
На указанный URL будут отправляться запросы-уведомления (вебхуки) при возникновении активностей по отправленным емейл-сообщениям, например открытие письма, переход по ссылке из письма, отписка от рассылки и др. Вебхук будет иметь вид массива событий. Каждый элемент массива будет включать такие параметры: 

Параметр

Тип

Описание

contactId

int

Идентификатор контакта.

email

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 в вашей CRM. 
 
Вы можете использовать эту информацию для следующих целей:
  • для сегментации клиентской базы с учетом активности клиентов по рассылкам
  • для аналитики комплексных рекламных кампаний, в которых одним из используемых каналов является eSputnik
  • для создания резервных копий базы данных дополненных информацией из eSputnik. 
Для более наглядного представления масштаба возможностей, которые открываются перед вами, представим следующую ситуацию. В колл-центр поступил звонок вашего клиента с вопросом об акции указанной в письме. У оператора возникают вопросы: какую акцию клиент имеет в виду? Какое письмо отправил именно этому клиенту отдел маркетинга сегодня? Эту проблему и решает отправка в CRM информации об активности подписчиков в режиме реального времени при помощи вебхуков.