Skip to main content
Integrate your email address with Endor Labs and automatically receive policy violations as email notifications.

​
Configure email integration

To configure an email integration, follow these steps:
  1. Select User menu > Integrations from the left sidebar.
  2. Under Notifications, click Add on the Email card. If you already have an email integration, click Manage instead.
  3. Click Add Notification Integration to open the Send Notifications to Email dialog.
  4. Enter a Name and Description for this integration.
  5. In Email addresses, enter up to eight email addresses separated by commas.
  6. Optional: select Propagate this notification target to all child namespaces to make this integration available in child namespaces.
  7. Click Add Notification Integration to save the integration.

​
Associate an action policy with the email notification

Users can create action policies to send an email notification when a scan matches policy conditions. For example, if there is a critical or high vulnerability, send an email notification. To send an email when a scan produces matching findings, create an action policy with a Send Notification action that targets your email integration. For the full procedure, see Create an action policy. The email-specific choices are:
  • Under Choose an Action, select Send Notification.
  • From Select notification targets, choose the email integration you created.
From Select aggregation type, choose how findings are grouped into notifications.
  • None (Notify for each Finding) sends a separate notification for each finding.
  • Project sends a single notification for all findings in a project.
  • Dependency sends a notification for every dependency.
  • Dependency per Package Version sends a notification for every unique combination of dependency and package version.

​
Customize email notification templates

Endor Labs provides a default template with standard information for the email. You can use the default template or you can choose to edit and customize this template to fit your organization’s specific requirements. You can also create custom templates using Go Templates.
  1. Select User menu > Integrations from the left sidebar.
  2. Under Notifications, click Manage on the Email card to view the configured notification integrations.
  3. Choose a notification integration, click the ellipsis on the right side, and click Edit Template.
  4. Make required changes to any of the following templates and click Save Template.
    • Open - This template applies when Endor Labs raises new notifications.
    • Update - This template applies when an existing notification updates, such as when findings change.
    • Resolve - This template applies when all findings reported by the notification resolve.
  5. Click Restore to Default to revert the changes.
  6. Use the download icon on the top right corner to download this template.
  7. Use the copy icon to copy the information in the template.

​
Data model

To create custom templates for email notifications, you must understand the data supplied to the template. See the EmailData message used for Open and Update templates. See the ResolvedEmailData message used for Resolve template. See the following protobuf specification for the NotificationData message referenced by EmailData. To understand Project, Finding, PackageVersion and RepositoryVersion definitions in this protobuf specification, see: See the following specification to understand a few additional functions available to the template. You can access these functions by using their corresponding keys.

​
Run a scan

Run the endorctl scan on your configured projects. See endorctl scan commands for more information. You can view email notifications of policy violations in your inbox.