Обзор

Интеграции

Руководство пользователя

Справочник API

Вебхуки

Вебхук для кликов

Что такое вебхук для кликов? #

Вебхук для кликов — это способ, которым Haskimail уведомляет ваше приложение о том, что уникальный получатель кликнул по отслеживаемой ссылке в вашем письме. Это может быть полезно в самых разных ситуациях: например, для определения эффективности ваших транзакционных писем (легко ли клиенты находят ссылку для сброса пароля? предпочитают ли они просматривать подтверждения заказов в личном кабинете?), или просто для целей аудита.

Вы также можете использовать API Сообщений, чтобы запрашивать (pull) данные о кликах, но с вебхуком Haskimail сам отправляет (push) вам эту информацию по мере ее поступления. Вебхук для кликов отправляет данные в ваше приложение в простом для разбора (парсинга) формате JSON.

Haskimail будет отправлять POST-запрос на ваш вебхук для каждого уникального клика по ссылке в письмах, отправленных в течение периода хранения (по умолчанию 45 дней, но его можно настроить в диапазоне от 7 до 365 дней). По истечении этого периода Haskimail не сможет определить уникальность клика и, следовательно, не будет отправлять событие на ваш вебхук для кликов в письмах, отправленных раньше установленного срока.

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

Например:

Вы отправляете одно письмо с отслеживаемой ссылкой Маше и Пете. Оба кликают по ссылке. Ваш сервер получит два вызова с уникальными данными вебхука. Однако, если Маша или Петя кликнут по этой же ссылке еще раз, ваш сервер не получит дополнительного события. Кроме того, если в вашем письме несколько ссылок, каждый клик по новой ссылке будет зарегистрирован как отдельное событие, и ваш вебхук получит еще один вызов с информацией о том, какая ссылка была нажата и каким получателем.

Для ссылок в письмах, которые старше вашего периода хранения, мы по-прежнему обеспечим перенаправление на исходный URL, но они не будут считаться уникальными, и поэтому событие вебхука отправлено не будет.

Примечание: Дата и время в поле ReceivedAt передаются в формате ISO 8601.

Настройка URL вебхука для кликов #

Через веб-интерфейс Haskimail

Войдите в аккаунт Haskimail, выберите нужный Сервер и Канал, а затем перейдите на вкладку «Вебхуки». Нажмите «Добавить вебхук», введите URL в поле «URL вебхука» и установите флажок напротив события «Клики» (CLICKED).

Через API

Вы можете настроить событие CLICKED с помощью API как при создании нового вебхука, так и при редактировании уже существующего.

Данные вебхука для кликов #

Пример полного JSON-документа, который будет отправлен POST-запросом на ваш URL вебхука, показан справа. A brief description of some of the more interesting fields is below:

  • message_id — идентификатор сообщения.
  • event — CLICKED
  • custom_vars — пользовательские метаданные, которые были добавлены в письмо.
  • recipient — email-адрес, на котором произошел клик.
  • url_original — оригинальный адрес ссылки.
  • url_pers — тадрес ссылки после подстановки пользовательских данных.
  • campaign_id — значение Tag, переданное при отправке.
  • event_time — временная метка, когда произошел клик.
  • server_id — id сервера, через который было отправлено письмо.
  • stream_id — id канала, через который было отправлено письмо.

Пример JSON данных вебхука

{
  "event": "CLICKED",
  "message_id": "883953f4-6105-42a2-a16a-77a8eac79483",
  "campaign_id": "Test",
  "custom_vars" : {
    "a_key" : "a_value",
    "b_key": "b_value"
   },
  "server_id": 23,
  "stream_id": 25,
  "recipient": "ivan@example.com",
  "event_time": "2019-11-05 16:33:54",
  "url_original": "https://haskimail.ru",
  "url_pers": "https://haskimail.ru"
}

Как можно использовать данные о кликах #

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

  • Определять, когда и откуда получатель кликнул по ссылке. Это особенно полезно, когда данные отслеживания открытий недоступны.
  • Проводить A/B-тестирование эффективности макетов ваших транзакционных писем.
  • Деактивировать ссылку (например, для сброса пароля) после однократного использования.
  • Уведомлять пользователей о подозрительной активности практически в реальном времени, если клик зарегистрирован из местоположения, которое отличается от места их входа в систему.