История страницы

...

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

• ID — номер вебхука;
• Статус — состояние вебхука ("Ошибка", "Работает", "Неизвестно", "Выключен");
• Название — название вебхука;
• Описание — описание вебхука;
• URL — адрес внешней системы сбора событий;
• Версия API — версия API вебхука, поддерживаемая ECCM;
• Включено — переключатель включения/выключения вебхука;
• Просмотр — кнопка открытия окна просмотра параметров вебхука.

...

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

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

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

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

Image Modified

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

...

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

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

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

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

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

Image Modified

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

...

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

Image Modified

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

...

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

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

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

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

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

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

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

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

Для отправки сообщений во внешнюю систему 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 — события комментариев проблемы.

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