Перейти к основному содержимому
Версия: 4.11-refactoring

Вебхуки

Вкладка «Вебхуки» раздела «Внешние системы» настраивает отправку событий сегмента во внешние системы: при наступлении события IQChannels обращается по указанному URL и передаёт данные о событии.

Открыть: выберите сегмент → вкладка Внешние системы → вкладка Вебхуки.

к сведению

Описание протокола, формата запросов и структуры ответов — в руководстве интегратора: Webhooks API.

Типы событий​

Вебхук создаётся с одним из типов событий (поле «Действия:» в окне добавления):

  • «Перевод обращения на оператора»
  • «Создано обращение»
  • «Оценка клиента»
  • «Клиент печатает сообщение»
  • «Клиент отправил сообщение»
  • «Оператор отправил сообщение»
  • «Оператор отправил сообщение с цитированием»
  • «Оператор загрузил файл»
  • «Оператор закрыл обращение»

Добавление вебхука​

Кнопка «Добавить вебхук» (требуется право «Управление внешними системами») открывает окно «Добавление вебхука» (при изменении — «Изменение вебхука»):

Окно «Добавление вебхука»: поля «Название:» и «Адрес:», селект «Действия:» — «Перевод обращения на оператора», блок фильтра «Каналы:» с включённым флажком «Включить фильтр», внизу кнопки «Отмена» и «Добавить»
  • «Название:» — произвольное имя, характеризующее внешнюю систему.
  • URL — адрес, на который IQChannels будет присылать события в публичном API.
  • «Действия:» — тип событий, которые будут отправляться на этот URL (один из перечисленных выше).
  • Фильтр «Каналы:» — флажок «Включить фильтр» и выбор каналов; вебхук будет срабатывать только на события выбранных каналов.
  • Фильтр «Операторы:» — флажок «Включить фильтр», поле поиска «Введите данные пользователя» и список операторов (клик по строке выбирает оператора); вебхук будет срабатывать только на события выбранных операторов.

Для событий «Создано обращение», «Клиент печатает сообщение», «Клиент отправил сообщение» и «Оценка клиента» фильтры каналов и операторов не отображаются — событие отправляется без фильтрации.

Кнопка «Добавить» сохраняет вебхук («Сохранить» при изменении).

Карточка вебхука​

Каждый вебхук отображается карточкой с полями:

ПолеОписание
Состояние«Включен» или «Выключен»
URLАдрес сервера, на который IQChannels отправляет события публичного API
ДействиеТип события вебхука
КаналыВыбранные каналы фильтра (если фильтр включён)
ОператорыВыбранные операторы фильтра (если фильтр включён)

Через меню шестерёнки карточки доступны действия «Изменить вебхук», «Включить вебхук», «Выключить вебхук» и «Удалить вебхук» (в зависимости от текущего состояния доступно либо включение, либо выключение).

При удалении открывается окно «Удаление вебхука» — подтвердите действие кнопкой «Удалить».