Configuring Integration Level Alerts

Learn how to set up alerts on Nightfall for Github

Nightfall sends alerts in real-time to the channels or platforms you configure. You can configure the following alerts:

  • Slack Alerts

  • Webhook

  • Jira Tickets

  • Email

The Nightfall for GitHub integration allows you to configure alerts at the policy level and also at the integration level.

When you configure alert settings at the integration level, the alert settings apply to all the policies, created for the Nightfall for Github integration. However, when you configure alert settings specifically for a policy, created in the GitHub integration, the alert settings are applicable only for the specific policy.

This document explains how to configure alerts at the integration level. To learn about how to configure alerts at the policy level, read this document.

Prerequisites

  • To use Slack as an alert method, you must first perform the required Slack configurations. You can refer to this document to learn more about how to configure Slack as an Alert platform.

  • To use Webhook as an alert method, you must first perform the required Webhook configurations. You can refer to this document to learn more about how to configure Webhook as an Alert platform.

Configure Alerts at the Integration Level

You can configure alerts at the integration level once you have installed the Nightfall for GitHub integration.

To configure alerts at the integration level:

  1. Navigate to the Nightfall for Github integration.

  2. Scroll down to the Alerting section.

  3. Nightfall provides you with the following alert methods.

    • Slack: Enter the name of the Slack channel to which the violation notifications from this integration must be directed and click Save.

    • Email: Enter the Email ID of the recipient to whom the violation notification must be sent and click Save.

    • Webhook: Enter the Webhook URL and HTTP headers

    • JIRA: Select the JIRA project, issue type, enter comments, and click Save changes.

When you configure alerts to a Webhook, Nightfall AI sends occasional posts to:

  • To validate that the Webhook is properly configured before the policy is saved.

  • Periodically thereafter to ensure that the Webhook is still valid.

The response to the test Webhooks is 200 status code if successful.

An example of Webhook request is as follows.

{
  "service": "nightfall",
  "test": true,
  "timestamp": "2024-03-07T23:18:39Z"
}

This is part of alert event consumption and can be ignored.

Last updated