Создание интеграции оповещения Webhooks

Эта статья объясняет, как создать интеграцию для вашей учетной записи Cato, использующую Webhooks для оповещений и системных уведомлений.

Обзор

Приложение Управления Cato поддерживает различные оповещения и уведомления для разных случаев использования и условий, связанных с вашей учетной записью. Вы можете определить интеграцию Webhook для отправки оповещений на сторонние платформы, такие как ServiceNow, Jira и Slack, и создавать автоматизированные потоки на основе оповещений. Webhooks Cato поддерживают настраиваемые HTTP-заголовки и сообщения в оповещениях, чтобы удовлетворить специфические потребности вашей организации.

Создание интеграций Webhook

Создайте интеграцию Webhook для соответствующего сервиса тикетов. Вам необходимо предоставить URL для сервиса, который получает оповещения через Webhook, с соответствующей информацией аутентификации. Доступны следующие методы аутентификации:

  • Basic - базовая аутентификация с именем пользователя и паролем.

  • Bearer - аутентификация Bearer с токеном Bearer.

  • Custom - некоторые сервисы используют пользовательскую аутентификацию и могут требовать пользовательских заголовков аутентификации и авторизации. Для этих сервисов выберите Custom Authentication и предоставьте соответствующий ключ и значение для каждого Custom Header.

У вас есть возможность настроить пользовательские HTTP-заголовки для Webhook. Вы можете использовать тело оповещения по умолчанию или настроить один из этих шаблонов JSON:

Примечание

Примечание: Если доступ к стороннему сервису ограничен определенными IP-адресами, пожалуйста, обратитесь к этой статье для списка IP-адресов Cato, которые необходимо разрешить (требуется авторизация для просмотра этой статьи).

  • Базовый - ID учетной записи, имя учетной записи, заголовок, тема, тип оповещения и содержание оповещения

    Поля в базовом шаблоне включены в большинство оповещений Cato

  • Все поля - все предопределенные поля включены в шаблон

  • ServiceNow - work_notes (содержимое оповещения), short_description (имя учетной записи и заголовок)

  • Jira - сводка (название учетной записи и заголовок), описание (содержимое оповещения)

  • Пользовательский - определите содержание для тела Webhook, вы можете начать с одного из вышеупомянутых шаблонов и внести изменения

Настройка содержимого оповещения

Поле content в шаблоне содержит сгенерированное читаемое резюме оповещения, аналогично содержанию оповещения электронной почты. Вы можете выбрать эти форматы для содержимого: contentText, contentMarkdown или contentHTML.

Если вы выбираете настраивать тело, доступно несколько полей данных, которые можно использовать в содержимом сообщения. Таким образом вы можете определить пользовательское тело (или структуру), а затем встроить поля данных Cato. Когда вы вводите $, отображаются доступные поля данных, а затем выберите необходимое поле. Поля используют автозаполнение для фильтрации списка. Для получения дополнительной информации о полях Cato см. Понимание полей JSON для интеграции оповещений.

Webhooks_page.png

Для создания интеграции Webhook:

  1. В меню навигации нажмите Аккаунт > Подписки и выберите вкладку Интеграции.

  2. Щелкните Новая Интеграция > Webhook. Открывается панель Новая Интеграция Webhook.

  3. Настройте следующие параметры интеграции:

    1. Введите Имя интеграции.

    2. Щелкните на ползунок, чтобы включить (зеленый) или отключить (серый) интеграцию (по умолчанию включено).

  4. Настройте Детали соединения:

    1. Введите URL для сервиса, который получает Webhook.

    2. Если необходимо, настройте Метод аутентификации и параметры для сервиса.

    3. Щелкните Тест. Если интеграция может подключиться к сервису, отображается сообщение Тест успешно пройден.

      Если возникает ошибка соединения, страница отображает код ошибки HTTP и сообщение, предоставленное сервисом.

  5. (Опционально) В Пользовательские Заголовки определите Ключ и Значение для каждого дополнительного HTTP заголовка для интеграции.

  6. В Пользовательское Тело определите содержимое оповещения Webhook:

    1. В Начать с шаблона выберите JSON шаблон для сообщения оповещения.

    2. (Опционально) В Редактировать Шаблон настройте содержимое оповещения.

      • Введите $ для встраивания других полей

      • Введите / в качестве символа экранирования

      После редактирования и сохранения содержимого предопределенного шаблона интеграция будет определена как шаблон Пользовательский.

  7. Нажмите Сохранить. Интеграция Webhook сохранена и добавлена на страницу Интеграции.

Определение Уведомлений о Политике с Webhooks

Политики безопасности Cato позволяют отправлять уведомления при совпадении правил. Вы можете настроить Отслеживание настроек для отправки уведомлений на конкретную интеграцию или в Группу подписок, содержащую интеграцию.

rule_webhook.png

Чтобы определить уведомление Webhook для правила:

  1. В соответствующей политике отредактируйте правило и расширьте раздел Действия.

  2. Выберите Отправить уведомление.

  3. Определите Частота отправки оповещения.

  4. В Отправить уведомление выберите Группа подписки или Интеграция и выберите соответствующий элемент.

  5. Нажмите Применить.

Была ли эта статья полезной?

Пользователи, считающие этот материал полезным: 0 из 1

0 комментариев