...

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

...

Операции с вебхуками

Для создания вебхука нажмите кнопку "Создать".

...

Для включения или выключения одного или нескольких вебхуков выделите соответствующие вебхуки с помощью флагов и нажмите кнопку "Включить" или "Выключить". Включение Также доступно включение и выключение одного вебхука также доступно переключателем в вебхука с помощью переключателя в соответствующей строке таблицы. 

Создание вебхука

Для создания нового вебхука нажмите на кнопку "Создать": откроется окно "Создать вебхук" с активной вкладкой "Общие настройки".

...

• Переключатель включения/выключения вебхука;

• URL — HTTP/HTTPS адрес сервера внешней системы;

• Доверенный сертификат TLS — сертификат внешней системы в формате PEM. Доступен только при использовании HTTPS;

• Секрет — секретное значение для формирования подписи запроса;
• Версия API — версия API вебхука, поддерживаемая ECCM;
• Типы событий — типы событий, отправляемые во внешнюю систему:
  • Heartbeat — Heartbeat — периодическая проверка доступности внешней системы;
  • Событие создано — создано — события ECCM;
  • Проблема создана, Проблема подтверждена, Проблема назначена, Проблема открыта, Проблема закрыта — /Проблема подтверждена/Проблема назначена/Проблема открыта/Проблема закрыта — события жизненного цикла проблемы;
  • Комментарий к проблеме создан, Комментарий /Комментарий к проблеме изменён, Комментарий изменен/Комментарий к проблеме удалён удален — события комментариев проблемы;
• Периодичность heartbeat, сек. — период отправки heartbeat-сообщений. Поле доступно только если выбран тип события Heartbeatсобытия Heartbeat.

Вкладка "Фильтры сообщений" доступна только при выборе событий ECCM, событий жизненного цикла проблемы или событий комментариев проблемы и выглядит следующим образом:

...

• Нажмите кнопку "Создать" — канал доставки будет создан;
• Нажмите кнопку "Отменить" — все настройки будут сброшены, диалоговое окно закроется.

Просмотр вебхука

При нажатии на кнопку в таблице отображается диалоговое окно просмотра вебхука:

...

• Название — наименование вебхука;
• Описание — описание вебухука при наличии;
• URL — HTTP-/HTTPS-адрес сервера внешней системы в сокращенной форме;
• Статус — состояние вебхука;
• Включено – — признак включения вебхука;
• Версия API — версия API вебхука, поддерживаемая ECCM;
• Типы событий — типы событий, отправляемые во внешнюю систему;
• Размер очереди — количество сообщений, ожидающих отправки во внешнюю систему, если оно задано.

...

• Отправить тестовое событие — отправка тестового сообщения во внешнюю систему;
• Редактировать — переход в форму редактирования вебхука;
• Закрыть — закрытие окна просмотра.

Тестирование вебхука

В форме создания/редактирования вебхука и в окне просмотра вебхука доступна кнопка "Отправить тестовое событие".

Image Added

При нажатии на кнопку отображается окно "Результат отправки" со статусом отправленного сообщения. Возможные статусы:

• успех — "Отправка тестового события выполнена успешно";
• ошибка — "Отправка тестового события завершилась ошибкой".

При отправке тестового события из кона окна просмотра статус вебхука будет обновлен статус вебхука.

Поля полезной нагрузки

Для отправки сообщений во внешнюю систему ECCM использует протокол HTTP(S) и формат полезной нагрузки JSON.

ECCM отправляет во внешнюю систему HTTP-запрос POST на URL вебхука. Внешняя система подтверждает приём прием ответом с кодом 200 OK. При любом другом ответе или ошибке сети ECCM повторяет отправку.

...