Email alert

Reading time: 0 minute(s) (0 words)

The email alert method sends automated and customized alert messages to up to 30 different inboxes per alert to notify Nobl9 users whenever an incident is triggered.

Configuring the email alert method

You can configure your email alert method directly in the Nobl9 UI, or by applying a YAML file in sloctl.

Allowlist

For reliable delivery of notifications, you may need to add no-reply@nobl9.com to your list of trusted emails.

Nobl9 UI

1. Navigate to Integrations > Alert Methods.
2. Click .
3. Click the relevant Alert Method icon.

Then, in the Email Configuration Wizard:

1. Select a Project.
   Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses the default project.
2. Enter a Display Name.
   You can enter a user-friendly name with spaces in this field.
3. Enter a Name.
   The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example, my-alert-method-1). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result.
4. Enter a Description.
   Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it.
5. Click Add Alert Method.

Now, you can compose your email alert:

1. Enter the address(es) of the desired recipient(s) for your email alert. You can add email addresses in three categories: To (for direct recipients), CC (carbon copy), or BCC (blind carbon copy).

   • You must provide at least one recipient in any one of these categories.

   • The maximum number of recipients for each category (To, CC, BCC) is 10.

   • You can paste a list of recipients. Email addresses must be separated with whitespace, commas (,), or semicolons (;). For example:

     email1@example.com email2@example.com
     email1@example.com,email2@example.com
     email1@example.com;email2@example.com
     email1@example.com ; email2@example.com,email3@example.com email4@example.com
2. Click Add Alert method.

YAML configuration

YAML - general

Here’s a general specification for adding an email alert method through YAML:

apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
  name: string
  displayName: # string, optional
spec:
  description: # string, optional
  email:
    to:
      - # string - sloctl validates if the string is a correct email address, max. number of recipients is 10
    cc:
      - # string - sloctl validates if the string is a correct email address, max. number of recipients is 10
    bcc:
      - # string - sloctl validates if the string is a correct email address, max. number of recipients is 10

YAML - sample

Here's an example of the email alert configuration through YAML:

apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
  name: email-notification
  displayName: Email notification
spec:
  description: Sends email notification to selected recipients
  email:
    to:
      - alerts-tests@example.com
    cc:
      - alerts-tests+cc@example.com
    bcc:
      - alerts-tests+bcc@example.com

Sample email alerts

The following are examples of Nobl9 email alerts for:

• High severity alert
• Medium severity alert
• Low severity alert

Image 1: Samples of Nobl9 email alerts for various alert states

Testing the email alert method in the UI

You can test alert methods for all notification services supported by the Nobl9 platform through the UI.

To verify the correctness of your alert method configuration:

1. Navigate to Integrations > Alert Methods.
2. Click the required alert method.
   Its Details page opens.
3. Click Test under the alert method name:
   
   • For the correct configuration, Nobl9 displays Test completed successfully! under the button
   • Otherwise, Nobl9 displays the Test failed message, specifying what is set incorrectly

Useful links

Email alert method | Terraform documentation