Раздел предназначен для создания и управления вебхуками — автоматическими запросами, отправляющими события и проблемы во внешнюю систему мониторинга. При наличии вебхуков система производит проверку соответствия каждого события и проблемы установленным фильтрам. Если событие или проблема соответствует фильтрам, вебхук отправляет данные во внешнюю систему. Подробная информация о настройке формирования событий и проблем приведена в соответствующих разделах "Правила генерации событий" и "Правила генерации проблем".
Во вкладке доступны следующие элементы управления:
Кнопки фильтрации, обновления, настройки отображаемых колонок и экспорта таблицы в CSV-файл;
Кнопка создания вебхука;
- Кнопка удаления вебхука;
- Поле поиска по вебхукам;
- Кнопка для открытия краткого руководства по поиску;
- Кнопки быстрой фильтрации по состоянию вебхука (Включено/Выключено/Работает/С ошибкой);
- Таблица вебхуков.
Таблица содержит следующие поля:
- ID — номер вебхука;
- Статус — состояние вебхука ("Ошибка", "Работает", "Неизвестно", "Выключен");
- Название — название вебхука;
- Описание — описание вебхука;
- URL — адрес внешней системы сбора событий;
- Версия API — версия API вебхука, поддерживаемая ECCM;
- Включено — переключатель включения/выключения вебхука;
- Просмотр — кнопка открытия окна просмотра параметров вебхука.
Статус вебхука определяется периодической отправкой запроса типа Heartbeat. Если данный тип событий не будет выбран при создании, то статус вебхука обновится при отправке события одного из выбранных типов или при отправке тестового события в окне просмотра.
Операции с вебхуками
Для создания вебхука нажмите кнопку "Создать".
Для просмотра параметров существующего вебхука нажмите на соответствующую иконку в столбце "Просмотр" с необходимым вебхуком.
Для редактирования существующего вебхука нажмите на строку таблицы с необходимым вебхуком.
Для удаления одного или нескольких вебхуков выделите соответствующие вебхуки с помощью флагов и нажмите кнопку "Удалить".
Для включения или выключения одного или нескольких вебхуков выделите соответствующие вебхуки с помощью флагов и нажмите кнопку "Включить" или "Выключить". Также доступно включение и выключение вебхука с помощью переключателя в соответствующей строке таблицы.
Создание вебхука
Для создания нового вебхука нажмите на кнопку "Создать": откроется окно "Создать вебхук" с активной вкладкой "Общие настройки".
Поэтапно заполните все разделы формы. По мере заполнения обязательных полей во вкладках их статус будет изменяться.
Форма содержит две вкладки:
- Общие настройки — параметры для отправки сообщений во внешнюю систему;
- Фильтры сообщений — параметры для фильтрации событий и проблем из ECCM при отправке во внешнюю систему.
Поля формы, доступные во всех вкладках:
- Название — название вебхука;
- Описание — описание вебхука.
Поля вкладки "Общие настройки":
Переключатель включения/выключения вебхука;
- URL — HTTP/HTTPS адрес сервера внешней системы;
Доверенный сертификат TLS — сертификат внешней системы в формате PEM. Доступен только при использовании HTTPS;
- Секрет — секретное значение для формирования подписи запроса;
- Версия API — версия API вебхука, поддерживаемая ECCM;
- Типы событий — типы событий, отправляемые во внешнюю систему:
- Heartbeat — периодическая проверка доступности внешней системы;
- Событие создано — события ECCM;
- Проблема создана/Проблема подтверждена/Проблема назначена/Проблема открыта/Проблема закрыта — события жизненного цикла проблемы;
- Комментарий к проблеме создан/Комментарий к проблеме изменен/Комментарий к проблеме удален — события комментариев проблемы;
- Периодичность heartbeat, сек. — период отправки heartbeat-сообщений. Поле доступно только если выбран тип события Heartbeat.
Вкладка "Фильтры сообщений" доступна только при выборе событий ECCM, событий жизненного цикла проблемы или событий комментариев проблемы и выглядит следующим образом:
Поля вкладки "Фильтры сообщений":
- Важность — уровень важности выбранных типов данных;
- Тип устройства — тип устройства, для которого будут отправляться сообщения во внешнюю систему;
- Область применения — группы/устройства, для которых формируются сообщения во внешнюю систему.
После заполнения всех обязательных полей выполните одно из следующих действий:
- Нажмите кнопку "Создать" — канал доставки будет создан;
- Нажмите кнопку "Отменить" — все настройки будут сброшены, диалоговое окно закроется.
Просмотр вебхука
При нажатии на кнопку в таблице отображается диалоговое окно просмотра вебхука:
В диалоговом окне отображаются следующие поля:
- Название — наименование вебхука;
- Описание — описание вебухука при наличии;
- URL — HTTP-/HTTPS-адрес сервера внешней системы в сокращенной форме;
- Статус — состояние вебхука;
- Включено — признак включения вебхука;
- Версия API — версия API вебхука, поддерживаемая ECCM;
- Типы событий — типы событий, отправляемые во внешнюю систему;
- Размер очереди — количество сообщений, ожидающих отправки во внешнюю систему, если оно задано.
В окне просмотра также доступны кнопки:
- Отправить тестовое событие — отправка тестового сообщения во внешнюю систему;
- Редактировать — переход в форму редактирования вебхука;
- Закрыть — закрытие окна просмотра.
Тестирование вебхука
В форме создания/редактирования вебхука и в окне просмотра вебхука доступна кнопка "Отправить тестовое событие".
При нажатии на кнопку отображается окно "Результат отправки" со статусом отправленного сообщения. Возможные статусы:
- "Отправка тестового события выполнена успешно";
- "Отправка тестового события завершилась ошибкой".
При отправке тестового события из окна просмотра статус вебхука будет обновлен.
Поля полезной нагрузки
Для отправки сообщений во внешнюю систему ECCM использует протокол HTTP(S) и формат полезной нагрузки JSON.
ECCM отправляет во внешнюю систему HTTP-запрос POST на URL вебхука. Внешняя система подтверждает прием ответом с кодом 200 OK. При любом другом ответе или ошибке сети ECCM повторяет отправку.
Сообщения из ECCM делятся на следующие типы:
- HEARTBEAT — периодическая проверка доступности внешней системы;
- EVENT_CREATED — события, соответствующие типу данных "События" из ECCM;
- PROBLEM_CREATED, PROBLEM_ACKNOWLEDGED, PROBLEM_ASSIGNED, PROBLEM_OPENED, PROBLEM_CLOSED — события жизненного цикла проблемы;
- PROBLEM_COMMENT_CREATED, PROBLEM_COMMENT_UPDATED, PROBLEM_COMMENT_DELETED — события комментариев проблемы.
Во внешнюю систему доставляется следующая информация:
| Поле | Описание | Пример значения |
|---|---|---|
apiVersion | Версия API вебхука, поддерживаемая ECCM | v1 |
eventId | Уникальный идентификатор события. Неизменный между повторными отправками | f3a5e7b2-1c4d-4a8e-9b6f-2d1c3e4f5a6b |
eventType | Тип события, отправленного во внешнюю систему | heartbeat |
createdAt | Время возникновения события в ECCM | 1765443533449 |
data | Полезная нагрузка события. Для heartbeat — пустой объект. Для остальных типов событий содержит сведения о событии или проблеме: идентификатор, уровень важности, тип и идентификатор устройства, путь групп, имя и описание, а также сведения об авторе изменения. |