Webhook

Вебхук — способ оповещения Клиента о произошедшем событии в Системе с помощью сообщений, отправленных по HTTPS с использованием протокола TLS. С помощью вебхуков можно отправлять уведомления внешним службам и настраивать удобную автоматизацию в режиме реального времени.

При возникновении события в Системе отправляется POST-запрос на URL-адрес, указанный в поле Webhook URL. POST-запрос принят, если получен ответ с кодом 200. Если ответ не получен, всего будет отправлено еще 11 запросов, после чего попытки доставить сообщение прекратятся.

Можно получать вебхуки о следующих событиях:

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

Настройка вебхуков

Чтобы настроить вебхуки, выполните следующие действия:

1. Перейдите на вкладку Пользователи.
2. Найдите пользователя, для которого необходимо настроить вебхуки, и нажмите на кнопку . Откроется окно изменения личных данных.
3. Перейдите на вкладку Управление оповещениями.

   

   Отметьте флажок напротив событий, о которых необходимо получать вебхуки, и нажмите Сохранить. Подробнее о других типах оповещений см. в разделе Управление оповещениями пользователя.

4. В поле Webhook URL введите URL-адрес, на который будут отправляться вебхуки, и нажмите Сохранить.

При необходимости проверить работу вебхуков нажмите Тестировать вебхук. При нажатии отправляется тестовый POST-запрос на указанный URL-адрес. Результат запроса отобразится в поле ниже.

Полезная нагрузка вебхуков

Полезная нагрузка вебхуков по событию Атака:

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

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

• 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-сессий:

• msg_type – тип сообщения. Возможное значение: bgp_down (разрыв BGP-сессий).
• peer_ip – IP-адрес BGP-сессии со стороны клиента.
• timestamp – временная метка события.
• event_id – идентификатор события.

Полезная нагрузка вебхуков по событию Истечение срока действия сертификата:

• msg_type – тип сообщения. Возможное значение: ssl_certificate_expires (истечение срока действия SSL-сертификата).
• certificate_subject – объект, которому выписан сертификат.
• certificate_issuer – центр сертификации, которым выпущен сертификат.
• valid_not_before – начало срока действия сертификата.
• valid_not_after – конец срока действия сертификата.
• kdp_name – название сертификата в системе KDP.
• kdp_resource – название ресурса, к которому привязан сертификат.

В начало