Webhook

Webhook — способ оповещения о событиях в системе Защита от DDoS-атак:Pro с помощью HTTPS-сообщений с использованием протокола TLS.

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

При возникновении события система отправляет POST-запрос на URL, указанный в поле Webhook URL.

• Запрос считается доставленным при получении ответа с кодом 200.
• Если ответ не получен, выполняется до 11 повторных попыток, после чего отправка прекращается.

Поддерживаемые событияПоддерживаемые события

Webhook может отправляться при следующих событиях:

• Атака
  • начало атаки;
  • завершение атаки.
• Аномалия
  • начало аномалии;
  • завершение аномалии.
• Истечение срока действия сертификата
• Разрыв BGP-сессии
• Отсутствие лога веб-сервера (syslog) для ресурса

Настройка webhookНастройка webhook

1. Войдите в Портал.

2. Перейдите в раздел Пользователи.

3. Найдите пользователя и нажмите кнопку настройки webhook.
   Результат: откроется окно редактирования профиля пользователя.

4. Перейдите на вкладку Управление оповещениями.

5. Отметьте события, по которым необходимо получать webhook-уведомления.

6. В поле Webhook URL укажите URL-адрес для приема POST-запросов.

7. Нажмите Сохранить.

Результат: webhook будет отправляться при наступлении выбранных событий.

Проверка работы webhookПроверка работы webhook

Для проверки корректности настройки:

1. Нажмите Тестировать webhook.
2. Система отправит тестовый POST-запрос на указанный URL.
3. Результат выполнения запроса отобразится в интерфейсе.

Результат: вы можете убедиться, что webhook успешно принимается внешней системой.

Полезная нагрузка webhookПолезная нагрузка webhook

Событие «Атака»Событие «Атака»

Передаются следующие параметры:

• msg_type — тип сообщения (attack_start, attack_stop, attack_short_term);
• attack_id — идентификатор атаки;
• attack_type — тип атаки;
• start_time, end_time — временные метки начала и окончания атаки;
• resource_id, resource_name — идентификатор и имя ресурса;
• group_id, group_name — идентификатор и имя группы ресурса;
• attacked_ips — список атакованных IP-адресов (если применимо);
• bps, pps, rps — пиковые значения трафика;
• bps_timestamp, pps_timestamp, rps_timestamp — временные метки пиковых значений.

Событие «Аномалия»Событие «Аномалия»

• msg_type — anomaly_start или anomaly_stop;
• anomaly_id — идентификатор аномалии;
• timestamp — время события;
• resource_id, resource_name;
• group_id, group_name;
• check_name — измеряемый параметр;
• check_measurement — единица измерения;
• max_value — максимальное значение;
• threshold — порог тревоги;
• excess_percentage — превышение порога в процентах.

Событие «Разрыв BGP-сессии»Событие «Разрыв BGP-сессии»

• msg_type — bgp_down;
• peer_ip — IP-адрес BGP-сессии;
• timestamp — время события;
• event_id — идентификатор события.

Событие «Истечение срока действия сертификата»Событие «Истечение срока действия сертификата»

• msg_type — ssl_certificate_expires;
• certificate_subject — объект сертификата;
• certificate_issuer — центр сертификации;
• valid_not_before, valid_not_after — срок действия;
• kdp_name — имя сертификата в системе;
• kdp_resource — ресурс, к которому привязан сертификат.

РезультатРезультат

Webhook позволяет интегрировать Защиту от DDoS-атак:Pro с внешними системами мониторинга, автоматизации и реагирования без участия пользователя.