Вебхуки коллтрекинга

Содержание:
1 Обзор
   1.1 Назначение и типы вебхуки
   1.2 Обобщённое описание принципа работы вебхуки коллтрекинга
2 Подключение и настройка вебхуков
3 Параметры, передаваемые в вебхуки и их описание

1 Обзор

1.1 Назначение и типы вебхуки

В коллтрекинге есть возможность передавать четыре типа вебхуки, они перечислены в таблице ниже:
Коллтрекинг передает вебхуки в режиме реального времени (real-time).

Подключив и настроив опцию "Вебхуки", Вы сможете передавать в Ваши внешние аналитические системы информацию о событиях, перечисленных в таблице выше. Интеграция с коллтрекингом через вебхуки может быть полезна для CRM-систем, систем сквозной аналитики, систем управления контекстной рекламой и внутренних аналитических систем рекламных агентств.

1.2 Обобщённое описание принципа работы вебхуки коллтрекинга

Принцип работы вебхуков следующий: коллтрекинг в момент совершения события на Вашем сайте будет отправлять GET-запрос на указанный в настройках вебхуков URL и передавать рекламные метки и другую информацию о событии в виде параметров. Соответственно, внешняя система сможет привязать звонок/обращение к конкретному контрагенту (если это CRM) или посетителю сайта и корректно отобразить данные о звонке, посетителе сайта и рекламных параметрах в собственных отчетах.

2 Подключение и настройка вебхуков

Чтобы подключить вебхуки, на сайте «Личный кабинет» следует:
1) выберите ВАТС;
2) выберите коллтрекинг, подключенный к Вашей ВАТС;
3) выберите Настройки;
4) выберите API;
5) выберите виджет коллтрекинга, который будем настраивать;
6) проверьте, создан ли Token для работы API. Для этого проверьте, указана ли строка символов в поле «Идентификатор, использующийся для обращения к API коллтрекинга», а также в группе «Доступные методы API» перечислены доступные Вам методы API, см. рисунок ниже. Если токен не создан, нажмите кнопку «Создать токен»;
7) выполните одно из следующих действий:
    - если Вы создаете первый вебхук, то на странице «API» в блоке «Вебхуки» будет отображаться поле «Вебхуки необходимы для отправки данных в ваши…», в котором нужно выбрать тип вебхука, который будем настраивать;
    - если Вы создаете второй и последующий вебхуки, то на странице «API» в блоке «Вебхуки» будет отображаться список ранее созданных вебхуков и кнопки и . Вам нужно нажать на кнопку , затем выбрать тип вебхука, который будем настраивать;
8) нажмите кнопку «Создать вебхук»:

В открывшемся конструкторе вебхуков, выполните следующие действия:
1) введите URL-адрес вебхука, на который необходимо передавать информацию. Формат URL адреса для вебхука следующий:
    https://example.com/
где:
    • https или http – протокол;
    • example.com - URL-адрес вебхука;
2) установите "галочки" в нужных Вам параметрах вебхука. В правой части конструктора вебхуков будет показано название параметра, то как тот или иной параметр будет называться в вебхуке;

3) нажмите кнопку "Сохранить":

На открывшейся странице "API" выполните:
1) нажмите кнопку "Скопировать ссылку";
2) нажмите кнопку Сохранить;
3) если Вам необходимо отправлять данные на несколько адресов, добавьте еще один вебхук и настройте его аналогично.

3 Параметры, передаваемые в вебхуки и их описание

Все доступные наименования параметров коллтрекинга перечислены в таблице ниже. Вы можете использовать их все (или часть из них) в любой комбинации в параметрах URL.