КАК И ЗАЧЕМ ИСПОЛЬЗОВАТЬ HTTP-ИНТЕГРАЦИЮ (WEBHOOK)?


HTTP-интеграция или webhook
Это передача данных с Popmechanic после заполнения формы или действия с ней в любой сторонний сервис.

Может использоваться, если:
- у вас самописный сервис рассылок или CRM-система;
- вы хотите дополнительно или первоочередно принимать данные в свои внутренние базы, а затем уже отправлять в сервис рассылок самостоятельно;
- с вашим сервисом рассылок или CRM-системой у нас нет готовой интеграции;

Принцип работы интеграции:
1) Ваши разработчики на вашем сайте или стороннем домене создают URL для принятия данных.
Чаще всего это будет ссылка в формате https://site.com/subscribe/
2) Вы в настройках конкретной формы, с которой хотите передавать данные создаете интеграцию с HTTP-запросом и вписываете тот URL, который вам дали разработчики.
3) Когда кто-то на вашем сайте заполняет эту форму - данные отправляются на этот URL в указанном формате.

Где найти HTTP-интеграцию
Выделите любую форму – Интеграции – HTTP-запрос:

Настройки интеграции:
URL – адрес обработчика, на который будет отправлен запрос.

HTTP-метод – тип запроса, который будет отправлен
Возможные варианты:
  • GET – запрос с передачей параметров в адресной строке(URL-адресе запроса);
  • POST – запрос с передачей параметров в теле(body) запроса;
  • PUT – заменяет все текущие представления ресурса данными запроса.
  • OPTIONS – используется для описания параметров соединения с ресурсом.
  • PATCH – используется для частичного изменения ресурса.
  • DELETE – запрос с передачей параметров для удаления экземпляра с указанным ID
Детальнее о методах HTTP
Чаще всего для интеграций используется GET, если данных немного или POST.

Тип передаваемых данных
Мы используем передачу данных в 2 форматах:
  • HTTP-форма (application/x-www-form-urlencoded) – значения кодируются в кортежах с ключом, разделенных символом '&', с '=' между ключом и значением.
  • JSON (application/json) – отправка параметров в формате объекта(набор пар ключ/значение) в теле запроса;

Передача параметров:
У нас в Popmechanic существует ряд зарезервированных переменных для интеграций:
  • %email% - email
  • %phone% - телефон
  • %first_name% - имя
  • %last_name% - фамилия
  • %name% - имя + фамилия
  • %id% - ID лида (число)
  • %url% - URL, на котором был получен лид
  • %domain% - домен, на котором был получен лид
  • %form_name% - название формы, которой был собран лид
  • %utm_source% - UTM source текущей сессии
  • %utm_medium% - UTM medium текущей сессии
  • %utm_campaign% - UTM campaign текущей сессии
  • %utm_term% - UTM term текущей сессии
  • %utm_content% - UTM content текущей сессии
  • %geo_city_ru% - город пользователя по-русски
  • %geo_city_en% - город пользователя по-английски
  • %geo_country_ru% - страна пользователя по-русски
  • %geo_country_en% - страна пользователя по-английски
  • %geo_geoname_id% - ID города пользователя в базе GeoNames
  • %created_date% - Дата создания в формате ISO (YYYY-MM-DD)
  • %created_time% - Дата и время создания в формате ISO (YYYY-MM-DDTHH:mm:ssssssss+TZ)
Кроме них для некоторых форм есть дополнительные поля, которые тоже можно передавать в формете %customs.gender%, где gender - машинное имя доп. поля.
Значение этих полей задаются в шаблоне верстки конкретной формы и можно узнать перейдя на вкладку Лиды - дополнительно. Там будет указано, как называются доп. поля для интеграции.

Пример интеграции:

Тестирование интеграции:

Вы можете сами проверить, как и какие данные будут отправляться при заполнении формы
Для этого можно воспользоваться сервисом для тестирования вебхуков «Request Catcher».
На созданную в нем ссылку мы можем отправить запрос и посмотреть, пришли ли данные и в каком виде.

1) Зайдите на сайт Request Catcher и создайте тестовую ссылку:
2) Скопируйте полученную ссылку и перейдите в интеграцию формы в Popmechanic:
3) Создайте запрос и добавьте набор данных к нему:
4) Создайте тестовую ссылку или включите форму на тестовой странице
Заполните форму на сайте и вернитесь в Request Catcher

Если вы все сделали верно, то там должен появится ваш запрос:
(скрольте вправо, чтобы увидеть его полностью)
Вам была полезна эта статья?