Configure Alerts for GitHub
Understand the process of configuring integration alerts for Nightfall for GitHub.
Last updated
Understand the process of configuring integration alerts for Nightfall for GitHub.
Last updated
The Nightfall for GitHub integration supports the configuration of alerts at the policy level and at the integration level. Alerts can be sent in GitHub to the following alert destinations.
When you configure alert settings at the integration level, the alert settings apply to all the policies, created for the GitHub integration. However, when you configure alert settings specifically for a policy, which is created in the GitHub integration, the alert settings are applicable only for that specific policy.
This document explains how to configure alerts at the integration level.
To use Slack as an alert platform, 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 platform, 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.
To use JIRA as an alert platform, you must have the DLP for the JIRA app installed from the Atlassian Marketplace. You can read more about the DLP for JIRA integration here.
You can configure alerts at the integration level once you have installed the Nightfall for GitHub DLP integration.
To configure alerts at the integration level:
Navigate to the GitHub integration.
Scroll down to the GitHub section.
You can configure one or multiple alert channels.
To configure Slack as an alert channel, click + Slack channel.
In the Slack alert channel field, enter the name of the Slack channel in which you wish to receive the alerts.
Click Save.
A confirmation pop-up box is displayed to confirm if the Slack channel (entered in the second step) must be used only for GitHub DLP integration or all the Nightfall integrations.
Select No, only integration level to use the Slack channel only for GitHub DLP, or select Yes, please to use the selected Slack channel for all the Nightfall integrations.
Click + Email.
Enter the Email ID of the recipient who should receive the notifications.
Click Save.
A confirmation pop-up box is displayed to confirm if the Email ID (entered in the second step) must be used only for GitHub DLP integration or all the Nightfall integrations.
Select No, only integration level to use the Slack channel only for GitHub DLP, or select Yes, please to use the selected Slack channel for all the Nightfall integrations.
Click + Webhook.
Enter the Webhook URL.
Click Test. If the test result is not successful, check the Webhook URL.
(Optional) Click Add Header to add headers.
Click Save.
When you configure alerts to a Webhook, Nightfall AI sends occasional posts 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.
This is part of alert event consumption and can be ignored.
Click + Jira Ticket.
Select a JIRA project from the Jira Project drop-down menu.
Select an issue type from the Issue Type drop-down menu.
(Optional) Add comments to be added in the JIRA ticket.
Click Save changes.
A confirmation pop-up box is displayed to confirm if the JIRA settings configured for the GitHub DLP integration must be applied to all the other Nightfall integrations too.
Select No, only integration level to use the configurations only for GitHub DLP, or select Yes, please to use the selected JIRA configurations for all the Nightfall integrations.
When an Event is triggered, Nightfall sends a notification to the end-user whose actions triggered the Event. While notifying the end-user, Nightfall also sends a text message. You can draft the text message to be sent to the end-user. This message applies to all the policies. Click Save changes once done.
