Перейти к основному содержанию

Вебхуки

Раздел «Вебхуки» отправляет подписанные POST-уведомления о событиях звонка на ваши адреса. Это раздел карточки «Качество и интеграции» в настройках агента: в строке «Вебхуки» видно число адресов агента или «Эндпоинтов пока нет», а щелчок по строке открывает окно «Качество и интеграции» на этом разделе. Навигация слева переключает разделы окна: рядом — аналитика после звонка, задачи агента и наблюдатели. Вебхуки помечены «Применяется сразу»: они сохраняются сразу, не входят в черновик агента и не требуют публикации.

Адреса агента

Адреса агента собраны в таблицу:
  • «Эндпоинт» — адрес, с чипами «секрет» и «таймаут N с», если они заданы.
  • «События» — события, которые получает адрес.
  • «Последний тест» — результат последнего пробного уведомления: «Успех» или «Ошибка» с кодом или причиной и время; —, если теста не было. Кнопка «Тест» рядом отправляет пробное уведомление, не дожидаясь настоящего звонка.
  • «Вкл.» — переключатель «Включён»: отправку можно приостановить, не удаляя адрес. Действует сразу.
Окно «Вебхуки»: настроенный адрес, его события, отметка секрета и кнопка «Добавить webhook»

Форма вебхука

Кнопка «Добавить webhook» в шапке раздела открывает боковую панель «Новый webhook»; щелчок по строке открывает ту же панель — «Редактировать webhook»:
  • «Адрес (URL)» — адрес, принимающий уведомления. Используйте https://; http:// тоже принимается. Адрес проверяется при сохранении: на запрещённый адрес — например, localhost, 127.0.0.1 или служебный адрес облака 169.254.169.254 — вебхук не сохранится, и форма покажет «Адрес вебхука запрещён политикой исходящих запросов» с причиной. Вебхук не отправляется и на адреса внутренней сети — 10.x.x.x, 172.16.x.x–172.31.x.x, 192.168.x.x, 100.64.x.x–100.127.x.x и имена на .local или .internal: IP-адрес такой сети форма не сохранит, а имя, которое ведёт во внутреннюю сеть, отклоняется при отправке. Если ваша система принимает вебхуки во внутренней сети, обратитесь в поддержку: адрес разрешат для вашей организации. Выключить или удалить сохранённый вебхук можно, не меняя адреса.
  • «События» — что отправлять: «Звонок завершён (call_ended)» — сразу после окончания звонка, и «Аналитика готова (call_analyzed)» — когда готовы разбор после звонка и запись. По умолчанию выбраны оба.
  • «Секрет подписи — имя env-переменной» — хранится только ссылка: значение берётся из окружения и не попадает в базу и логи.
  • «Таймаут ответа» — максимальное ожидание ответа вашего сервиса, в секундах; 0 означает дефолт пайплайна.
  • «Включён» — отправку можно приостановить, не удаляя адрес.
  • «Слать события тест-сессий» — по умолчанию выключено, чтобы тесты из редактора не дёргали вебхук.
  • «Слать события звонков, сброшенных до ответа» — по умолчанию включено. Выключите, если ваша система не ждёт входящих звонков, которые звонящий сбросил до ответа агента: такие звонки не принесут call_ended и call_analyzed. У них нет разговора и нет переменных из SIP-заголовков, и интеграция может принять их за сбой. Остальные звонки приходят как обычно.
  • «Удалить вебхук…» — удаляет адрес после подтверждения; история доставок сохраняется.
Вебхук принадлежит одному агенту. Поля с выбором агента в форме нет: вебхук принадлежит тому агенту, в настройках которого заведён. Вебхука на всю организацию не бывает — чтобы получать события по нескольким агентам, заведите адрес у каждого; URL можно переиспользовать, различать их по agent_id в payload. Что приходит в уведомлениях, с примерами, — на странице «Вебхуки»; подпись, повторы и порядок доставки — в Web API.