Article

    help.nightfall.ai / gmail / integration_alerts.md

    6 min read
    Last updated 1 month ago

    For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs; this page is available as Markdown.

    Configure Alerts for Gmail

    Nightfall DLP for Gmail supports the configuration of alerts at the policy level and at the integration level. Alerts for Gmail can be sent to the following alert destinations.

    <figure><!--kb:media-unavailable--><figcaption></figcaption></figure>

    When you configure alert settings at the integration level, the alert settings apply to all the policies, created for the Gmail DLP integration. However, when you configure alert settings specifically for a policy, which is created in the Gmail DLP integration, the alert settings are applicable only for that 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 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.

    Configure Alerts at the Integration Level

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

    To configure alerts at the integration level:

    1. Navigate to the Gmail DLP integration
    2. Scroll down to the Alerting section.
    3. You can configure one or multiple alert channels.

    Configuring Slack as an Alert Channel

    1. To configure Slack as an alert channel, click + Slack channel.
    <figure><!--kb:media-unavailable--><figcaption></figcaption></figure>
    1. In the Slack alert channel field, enter the name of the Slack channel in which you wish to receive the alerts.
    2. Click Save.
    <figure><!--kb:media-unavailable--><figcaption></figcaption></figure>

    A confirmation pop-up box is displayed to confirm if the Slack channel (entered in the second step) must be used only for Gmail DLP integration or all the Nightfall integrations.

    1. Select No, only integration level to use the Slack channel only for Gmail DLP, or select Yes, please to use the selected Slack channel for all the Nightfall integrations.
    <figure><!--kb:media-unavailable--><figcaption></figcaption></figure>

    Configuring Email as an Alert Channel

    1. Click + Email.
    <figure><!--kb:media-unavailable--><figcaption></figcaption></figure>
    1. Enter the Email ID of the recipient who should receive the notifications.
    2. Click Save.
    <figure><!--kb:media-unavailable--><figcaption></figcaption></figure>

    A confirmation pop-up box is displayed to confirm if the Email ID (entered in the second step) must be used only for Gmail DLP integration or all the Nightfall integrations.

    1. Select No, only integration level to use the Slack channel only for Gmail DLP, or select Yes, please to use the selected Slack channel for all the Nightfall integrations.
    <figure><!--kb:media-unavailable--><figcaption></figcaption></figure>

    Configuring Webhook as an Alert Channel

    1. Click + Webhook.
    2. Enter the Webhook URL.
    3. Click Test. If the test result is not successful, check the Webhook URL.
    4. (Optional) Click Add Header to add headers.
    5. Click Save.
    <figure><!--kb:media-unavailable--><figcaption></figcaption></figure>

    {% hint style="info" %} 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.

    <pre class="language-json"><code class="lang-json"><strong>{ </strong> "service": "nightfall", "test": true, "timestamp": "2024-03-07T23:18:39Z" } </code></pre>

    This is part of alert event consumption and can be ignored. {% endhint %}

    Configuring Jira as an Alert Channel

    1. Click + Jira Ticket.
    2. Select a JIRA project from the Jira Project drop-down menu.
    3. Select an issue type from the Issue Type drop-down menu.
    4. (Optional) Add comments to be added in the JIRA ticket.
    5. Click Save changes.
    <figure><!--kb:media-unavailable--><figcaption></figcaption></figure>

    A confirmation pop-up box is displayed to confirm if the JIRA settings configured for the Gmail DLP integration must be applied to all the other Nightfall integrations too.

    1. Select No, only integration level to use the configurations only for Gmail DLP, or select Yes, please to use the selected JIRA configurations for all the Nightfall integrations.
    <figure><!--kb:media-unavailable--><figcaption></figcaption></figure>

    Configure End-User Notifications

    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.

    <figure><!--kb:media-unavailable--><figcaption></figcaption></figure>

    Agent Instructions

    This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

    Querying This Documentation

    If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

    Perform an HTTP GET request on the current page URL with the ask query parameter, and the optional goal query parameter:

    GET https://help.nightfall.ai/gmail/integration_alerts.md?ask=<question>&goal=<endgoal>
    

    ask is the immediate question: it should be specific, self-contained, and written in natural language. goal is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

    The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

    Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.