Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention failed scans for emails #2054

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs/semgrep-appsec-platform/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ slug: email-notifications
append_help_link: true
title: Email
hide_title: true
description: "Receive Semgrep findings via email."
description: "Receive Semgrep findings through email."
tags:
- Semgrep AppSec Platform
---
Expand All @@ -12,7 +12,7 @@ import Notifications from "/src/components/concept/_notification-deduplication.m

# Receive email notifications

You can choose to receive notifications from Semgrep regarding new findings through email.
You can receive emails from Semgrep regarding **new findings** and **failed scans**.

Perform these steps in Semgrep AppSec Platform to create an email integration and receive notifications:

Expand All @@ -27,11 +27,14 @@ Perform these steps in Semgrep AppSec Platform to create an email integration an
2. Click the **Edit** button of the Rule Mode for which you want to receive email notifications. For example, if you want to be notified of all blocking findings through email, click the **Edit** button of the **Block** mode.
3. Repeat the previous step for all Rule Modes that you want to receive notifications for.

![Screenshot of Semgrep AppSec Platform email with findings](/img/integrations-email-findings.png)
**Figure** Sample of an email sent from Semgrep with findings.
![Semgrep AppSec Platform email with findings](/img/integrations-email-findings.png)
_**Figure** Sample of an email sent from Semgrep with findings._

![Scan failure email](/img/email-failure.png#md-width)
_**Figure** Scan failure email message._

<Notifications />

### Number of emails

While emails are triggered only when Semgrep identifies a new finding, the emails you receive also include a summary of all findings.
Emails about new findings are triggered only once. These emails also include a **summary** of current open findings.
Binary file added static/img/email-failure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.