Перейти к основному содержимому

Вебхуки

В Sendsay с помощью вебхуков вы можете отслеживать следующие события:

  • уникальное открытие письма,
  • переход по ссылке,
  • отписка и отмена отписки,
  • доставка,
  • заполнение формы,
  • подтверждение регистрации,
  • изменение черновика,
  • открытие целевой страницы,
  • трекер,
  • новый подписчик,
  • ответ на письмо.

Как настроить вебхуки​

Чтобы настроить вебхуки, перейдите в раздел Настройки системы → Вебхуки:

webhooks

На шаге Формат уведомления выберите, в каком формате получать уведомления:

webhooks format

  • JSON — стандартный формат, передается как элемент events в виде JSON-массива, содержащего по одному элементу на событие.
  • JSON Stream — JSON-объекты описывают события, следующие друг за другом, без разделителя (запятой), возможно разделение пробельными символами (пробелы и переводы строк). Формат подходит для автоматизированного разбора.

На шаге Установка вебхуков настройте вебхуки для событий: нажмите «Добавить» и укажите URL-адрес, на который будут приходить уведомления. При необходимости для одного события можно добавить несколько URL.

add webhook

Настроенные события передаются по мере накопления с интервалом около 1 минуты.

Описание передачи событий в API

Как сохранять отчёты по вебхукам​

Вебхуки можно сохранять в хранилище аккаунта в разделе Настройки системы → Файлы → Отчёты.

Для этого при настройке события нужно указать адрес вида rfs://report/ПАПКА_СОБЫТИЯ. Например, для события Переход по ссылке адрес будет выглядеть как rfs://report/callback/click.

Как проверить работу вебхуков​

Проверить, как работают вебхуки, можно через сервис Webhook.site:

  1. Перейдите на сайт и скопируйте уникальную ссылку, которую сервис сгенерирует автоматически.

    webhook site

  2. В Sendsay перейдите в раздел Настройки системы → Вебхуки, напротив нужного события нажмите «Добавить» и вставьте скопированную ссылку.

После выполнения настроенного события в сервисе Webhook.site появится уведомление с подробностями.