Действие «Webhook»

Читать 13

Описание


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

advice_ver2.png Действие доступно как для разовых рассылок, так и для триггерных сценариев.

Добавление действия

Добавить блок действия на полотно можно двумя способами:

  • Для рассылок и триггерных сценариев — нажатием на кнопку «+» в левой верхней части полотна, затем выбрав соответствующие раздел и блок:


  • Для триггерных сценариев — при одинарном нажатии на один из выходов блока выводится кнопка «+», описанная выше. При таком создании будет автоматически установлена связь между блоками:


Установка связи с блоком

Установка связи между блоками производится вытягиванием связующей линии из одного блока и отпусканием линии на требуемом блоке.

Настройка блока 

Для редактирования/просмотра блока кликните на блок в любой его части. После нажатия открывается сайдбар:


Выбор шаблона

Требуется выбрать либо ранее созданный шаблон, либо в этом же блоке создать новый. При выборе ранее созданного шаблона в сайдбаре будут отражены его настройки. Рядом с названием шаблона отображается кнопка «Редактировать», по нажатию на которую в новой вкладке откроется страница с данным шаблоном в соответствующем разделе продукта.

 

Создание шаблона

Для создания нового шаблона выберите соответствующий пункт в выпадающем списке:


При создании нового шаблона потребуется указать:

  • Название шаблона;
  • Адрес обработчика, на который будут отправляться запросы;
  • Метод передачи данных (GET или POST);
  • Передаваемые поля, которые требуются вам для работы с клиентом.

Созданный шаблон автоматически отобразится в разделе «Шаблоны действий».

Список передаваемых параметров представлен в таблице:

Название Параметр Описание Ограничения
Тип вебхука type
Тип вебхука. В качестве значения всегда передается calltouchLeads.
—
Дата и время отправки вебхука в формате Unix Time Stamp sendingTimestamp
Дата и время отправки вебхука в формате Unix Time Stamp в секундах.
—
ID клиента clientId
ID клиента, в рамках которого осуществлено действие.
Если отсутствует, то значение не указывается.
—
Номер клиента phone
Телефонный номер клиента из лида в формате 7XXXXXXXXXX.
Если отсутствует, то значение не указывается.
—
Email клиента email
Почта клиента user@server.com.
Если отсутствует, то значение не указывается.
—
ФИО клиента fio
Имя клиента.
Если отсутствует, то значение не указывается.
—
Дата и время первого касания firstInteractionDate
Дата и время первого касания клиента в формате yyyy-mm-dd hh:mm:ss.
—
Дата и время последнего касания lastInteractionDate
Дата и время последнего касания в формате yyyy-mm-dd hh:mm:ss.
—
 Менеджер клиента  clientManager Менеджер клиента. Если несколько, то перечисляются через запятую. —
Теги клиента clientTags
Теги клиента.
Если отсутствует, то значение не указывается.
—
ID сайта siteId
ID проекта Calltouch, в рамках которого осуществлено действие.
—
Название сайта siteName
Название проекта Calltouch, в рамках которого осуществлено действие.
—
ID сценария scenarioId
Идентификатор сценария, в рамках которого осуществлено действие.
—
Название сценария scenarioName
Название сценария, в рамках которого осуществлено действие.
—
Тип сценария scenarioType
Тип сценария, в рамках которого осуществлено действие.
Доступные значения:
  • Разовый;
  • Триггерный.
 —
ID аудитории audienceId
Идентификатор аудитории, используемой в сценарии.
—
Название аудитории audienceName
Название аудитории, используемой в сценарии.
—
Тип аудитории audienceType
Тип аудитории, в рамках которой осуществлено действие.

Доступные значения:

  • Текущий проект;
  • Группа проектов.

 —
Тип события triggerType
Тип события, в результате которого осуществлено действие.
Доступные значения:
  • Новая сессия;
  • Новый лид;
  • Новая сделка;
 Только для триггерных сценариев.
Источник source
Источник сессии, в рамках которой клиент вернулся на сайт.
Только для события «Новая сессия» триггерных сценариев.
Канал medium
Канал сессии, в рамках которой клиент вернулся на сайт.
Только для события «Новая сессия» триггерных сценариев.
Метка utm_campaign utmCampaign
Метка utm_campaign, в рамках которой клиент вернулся на сайт. Если в URL перехода отсутствовали все utm-метки, то передается значение <не указано>. Если в URL перехода были utm-метки, но utm_campaign отсутствовала или была пуста, то передается значение <не заполнено>.
Только для события «Новая сессия» триггерных сценариев.
Метка utm_content utmContent
Метка utm_content, в рамках которой клиент вернулся на сайт. Если в URL перехода отсутствовали все utm-метки, то передается значение <не указано>. Если в URL перехода были utm-метки, но utm_content отсутствовала или была пуста, то передается значение <не заполнено>.
Только для события «Новая сессия» триггерных сценариев.
Метка utm_term utmTerm
Метка utm_term, в рамках которой клиент вернулся на сайт. Если в URL перехода отсутствовали все utm-метки, то передается значение <не указано>. Если в URL перехода были utm-метки, но utm_term отсутствовала или была пуста, то передается значение <не заполнено>.
Только для события «Новая сессия» триггерных сценариев.
ID посетителя сайта ctClientId
Идентификатор вернувшегося посетителя Calltouch. Он представляет из себя значение cookie _ct.
Только для события «Новая сессия» триггерных сценариев.
Глобальный ID посетителя сайта ctGlobalId
Глобальный идентификатор посетителя Calltouch, общий для сайтов, на которых установлен скрипт Calltouch. Он представляет из себя значение сквозной cookie _ct_client_global_id. Значение параметра формируется только при включении соответствующего сеттинга (требуется обратиться к вашему менеджеру). Если сеттинг не включен или значение отсутствует, то значение не указывается.
Только для события «Новая сессия» триггерных сценариев.
Google Client ID gcid
Идентификатор Google Client ID.
Если Google Client ID не удалось определить, то значение не указывается.
Только для события «Новая сессия» триггерных сценариев.
Yandex Client ID yaClientId
Идентификатор Yandex Client ID.
Если Yandex Client ID не удалось определить, то значение не указывается.
Только для события «Новая сессия» триггерных сценариев.
Домен domain
Домен сайта в рамках сессии возвращения клиента.
Если домен не удалось определить, то значение не указывается.
Только для события «Новая сессия» триггерных сценариев.
Страница входа на сайт urlEntry
URL входа на сайт в рамках сессии возвращения клиента.
Если не удалось определить, то значение не указывается.
Только для события «Новая сессия» триггерных сценариев.
Страница выхода urlExit
URL выхода с сайта в рамках сессии возвращения клиента.
Если не удалось определить, то значение не указывается.
Только для события «Новая сессия» триггерных сценариев.
Время на сайте sessionDuration
Время, проведенное на сайте в рамках сессии возвращения клиента, в секундах.
Если не удалось определить, то значение не указывается.
Только для события «Новая сессия» триггерных сценариев.
Достигнутые цели goals
Достигнутые цели в рамках сессии возвращения клиента. Передаются через запятую.
Если достигнутых целей не было, то значение не указывается.
Только для события «Новая сессия» триггерных сценариев.
 Товары в корзине  productsInBasket Товары, которые были добавлены в корзину в рамках сессии. Передаются по формату: название_1 (категория_1, бренд_1, разновидность_1, цена_1, количество_1), название_2 (категория_2, бренд_2, разновидность_2, цена_2, количество_2). Только для события «Завершение сессии» триггерных сценариев.
 Заказанные товары  orderedProducts Товары, по которым зафиксирован заказ в рамках сессии. Передаются по формату: название_1 (категория_1, бренд_1, разновидность_1, цена_1, количество_1), название_2 (категория_2, бренд_2, разновидность_2, цена_2, количество_2). Только для события «Завершение сессии» триггерных сценариев.
Теги tags
Теги лида или сделки. Передаются через запятую.
Если тегов нет, то значение не указывается.
Только для событий «Новый лид», «Новая сделка»  триггерных сценариев.
Вид лида leadKind
Вид лида.
Доступные значения:
  • Звонок;
  • Обратный звонок;
  • Заявка.
 Только для события «Новый лид» триггерных сценариев.
Типы лида leadTypes
Типы лида, к которым принадлежит конкретный лид.
Передается через запятую.
Доступные значения:
  • unique;
  • target;
  • uniqueTarget;
  • nonTarget;
  • repeated.
 Только для события «Новый лид» триггерных сценариев.
 Комментарий  leadComment Комментарий звонка или заявки.

Передается только для триггерных сценариев с событиями «Новый лид» и «Изменение лида».

Только для событий «Новый лид» и «Изменение лида» триггерных сценариев.
Воронка dealFunnel
Воронка сделки.
Только для события «Новая сделка» триггерных сценариев.
Этап dealStatus
Этап сделки.
Только для события «Новая сделка» триггерных сценариев.
Менеджер dealManager
Менеджер сделки.
Только для события «Новая сделка»  триггерных сценариев.
Название сделки dealName
Название сделки.
Только для события «Новая сделка»  триггерных сценариев.
Выручка dealRevenue
Выручка сделки.
Только для события «Новая сделка» триггерных сценариев.
Ссылка на ближайший лид клиента clientLastLeadUrl
Ссылка на ближайший лид пользователя (звонок или заявка). Если у клиента нет лидов, то значение не указывается.
—
Ссылка на ближайшую сделку клиента clientLastDealUrl
Ссылка на ближайшую сделку пользователя. Если у клиента нет сделок, то значение не указывается.
—

Для проверки корректности работы вы можете отправить тестовый запрос на ваш обработчик, используя кнопку «Отправить тестовый запрос».

Для применения настроек в блоке нажмите на кнопку «Сохранить» в нижней части сайдбара.

Перетаскивание блока

Блоки в разовой рассылке недоступны для перетаскивания. Блоки в триггерных сценариях можно перемещать по полотну, зажимая левую кнопку мыши на заголовке блока. Отпустите клавишу мыши на нужном месте полотна. 

Удаление блока


При нажатии на соответствующую кнопку блок будет удален с полотна. После удаления не забудьте установить связи блоков, нарушенных после удаления.


Похожие статьи
Недавно просмoтренные