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

Во вкладке доступны следующие элементы управления:

  1. Кнопки фильтрации, обновления, настройки отображаемых колонок и экспорта таблицы в CSV-файл;

  2. Кнопка создания вебхука;

  3. Кнопка удаления вебхука;
  4. Поле поиска по вебхукам;
  5. Кнопка для открытия краткого руководства по поиску;
  6. Кнопки быстрой фильтрации по состоянию вебхука (Включено/Выключено/Работает/С ошибкой);
  7. Таблица вебхуков.

Таблица содержит следующие поля:

Статус вебхука определяется периодической отправкой запроса типа Heartbeat. Если данный тип событий не будет выбран при создании, то статус вебхука обновится либо при отправке одного события из выбранных типов, либо при отправке тестового события в окне просмотра

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

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

Для просмотра параметров существующего вебхука нажмите на соответствующую иконку в столбце "Просмотр" с необходимым вебхуком.

Для редактирования существующего вебхука нажмите на строку таблицы с необходимым вебхуком.

Для удаления одного или нескольких вебхуков выделите соответствующие вебхуки с помощью флагов и нажмите кнопку "Удалить".

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

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

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

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

Форма содержит две вкладки:

Поля формы, доступные во всех вкладках:

Поля вкладки "Общие настройки":

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

Поля вкладки "Фильтры сообщений":

После заполнения всех обязательных полей выполните одно из следующих действий:

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

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

В диалоговом окне отображаются следующие поля:

В окне просмотра также доступны кнопки:

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

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

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

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

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

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

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

Сообщения из ECCM делятся на следующие типы:

Во внешнюю систему доставляется следующая информация:

ПолеОписаниеПример значения
apiVersionВерсия API вебхука, поддерживаемая ECCMv1
eventIdУникальный идентификатор события. Неизменный между повторными отправкамиf3a5e7b2-1c4d-4a8e-9b6f-2d1c3e4f5a6b
eventTypeТип события, отправленного во внешнюю системуheartbeat
createdAtВремя возникновения события в ECCM1765443533449
dataПолезная нагрузка события. Для heartbeat — пустой объект. Для остальных типов событий содержит сведения о событии или проблеме: идентификатор, уровень важности, тип и идентификатор устройства, путь групп, имя и описание, а также сведения об авторе изменения.