Канал коммуникации Webhook
Webhook в Campaign
Система предоставляет возможность отправлять HTTP-запросы (так называемые “веб-хуки”) во внешнюю систему. Век-хуки можно использовать, чтобы передавать запрос-сообщение по API во вне без разработки дополнительной интеграции.
Для чего применяется
Канал можно использовать. если вам нужно периодически отправлять однотипный запрос по API во внешнюю систему, используя подстановку метапеременных.
Примеры:
- Отправить в колл-центр запрос на обзвон
- Отправить в систему генерации купонов запрос на выпуск купона
- Отправить во внешнюю систему обновление заказа
И другое.
Согласие на Webhook
По умолчанию, отдельное согласие от клиента для отправки веб-хука не требуется и не используется. Но при необходимости при построении сегмента можно использовать фильтры с согласием на другие виды коммуникаций – СМС, Емейл, Push.
Технологии отправки Webhook
Использовать функцию можно для передачи HTTP-запроса POST в виде json с использованием авторизации. Поддерживается авторизация двух типов: basic (логин/пароль), bearer (заголовок Auth и Bearer XXX), также можно включить аноним (без авторизации).
Правила формирования запроса
URL для запроса формируется как URL из настройки провайдера + метод из настройки шаблона.
Сообщение берется из текста запроса из шаблона.
Параметры авторизации берутся из настройки провайдера.
И с этими параметрами отправляется POST запрос по протоколу HTTP в формате JSON.
Как подключить Webhook-рассылки в Campaign.
Чтобы начать использовать этот канал коммуникации, необходимо сначала создать имя отправителя (провайдера).
Провайдером выступает система, куда будут направляться запросы. Чтобы настроить провайдера, необходимо направить вашему персональному менеджеру запрос и передать параметры:
- URL, куда будет отправляться запрос. При этом, если требуется отправлять на один URL разными методами, которые указываются в ссылке после /, нет необходимости под каждый метод делать провайдер. В провайдере указываем только общую ссылку, а метод будет добавляться в самом шаге при настройке коммуникации.
- Параметры авторизации, если она есть.
Когда провайдер будет добавлен, появится возможность выбрать его из списка при настройке шага отправки веб-хука и отправлять на него запросы.
Количество провайдеров, которые можно добавить, не ограничено.
Имя отправителя создает сотрудник Manzana.
Настройка шаблона Webhook
Как для любого канала коммуникации, необходимо создать или выбрать готовый шаблон. Можно сделать это внутри шага коммуникации Webhook либо в разделе Шаблоны, где из выпадающего списка необходимо выбрать Webhook. В списке будут представлены все, созданные ранее в системе, шаблоны. Можно открыть любой шаблон для редактирования, скопировать его или удалить. Также можно создать новый, нажав на кнопку «Создать».
Откроется форма создания нового шаблона.
Шаблон имеет три поля для заполнения: название, метод и тело запроса.
Название
Это наименование шаблона, можно указать любое. Мы рекомендуем использовать понятные уникальные наименования, чтобы их было легко найти поиском в списке шаблонов.
Метод
В поле Метод шаблона webhook можно указать метод, который будет добавляться после URL в случае необходимости. То есть. если у вас есть один общий URL для отправки запросов, но есть разные методы, которые обычно указываются в ссылке после разделителя «/», то этот метод добавляется в поле Метод. Например, у API сторонней системы есть три метода:
https://urlforapi.ru/sendsmth/one, https://urlforapi.ru/sendsmth/two, https://urlforapi.ru/sendsmth/three. И в таком случае в провайдере URL указывается https://urlforapi.ru/sendsmth, а в поле метод добавляется уже /one, /two, /three, в зависимости от того. какой метод нужно вызывать.
Поле Метод необязательное. Если в шаблоне метод пустой, то отправка идет только на то, что указано в URL.
Тело запроса
В поле указывается сам запрос, который нужно отправить. Формат запроса – json, поэтому указывать запрос нужно сразу в этом формате, так как он не будет дополнительно преобразовываться и будет в таком же виде отправлен.
Поле Тело запроса обязательное для заполнения.
В тело запроса также можно подставить персонализированные метапеременные. Подробнее про настройку метапеременных можно прочитать в статье.
Как использовать канал Webhook в Campaign
Когда заведен провайдер и создан шаблон, можно добавлять шаг Webhook в коммуникационную акцию.
Общие принципы применения шага идентичны применению других каналов коммуникаций.
Для настройки отправки веб-хука необходимо вытащить в конструктор акции шаг, поместить его в нужном месте цепочки аналогично другим типа коммуникации и настроить.
На вкладке Конструктор необходимо выбрать нужного отправителя (это провайдер, которого заводили ранее) и шаблон. После выбора шаблона станут доступными вкладки Редактирование и Тестирование.
На вкладке Редактирование аналогично другим видам коммуникаций можно внести изменения в текст рассылки, не меняя сам шаблон.
С вкладки Тестирование можно отправить тестовый webhook. Происходит отправка единичного запроса, адресаты вбивать не требуется. То есть при нажатии на кнопку «Отправить» просто выполняется отправка веб-хука с параметрами из шаблона на нужный URL.
Получение статистики
При отправке веб-хуков текст ответа от внешней системы на запрос не обрабатывается, Manzana Campaign получает обратно HTTP-код ответа на запрос и сохраняет его. Поэтому возможно получение и отображение в статистике двух статусов: Отправлено или Ошибка.
В статистике можно посмотреть следующие данные по отправке webhook:
- Участников: количество участников программы, которые были отобраны и «пришли на шаг веб-хука» для отправки.
- Отправлено: сколько запросов было успешно отправлено (на запрос получили http-код 200 (ОК)).
- Ошибок: сколько запросов не отправилось (на запрос получили http-код, отличный от 200, например 400/500 и тд)
Статистика по отправленным webhook доступна:
- на шаге коммуникации Webhook после активации акции появляется вкладка Статистика,
- в общем разделе Статистика в Manzana Campaign.