EBS: How to Set Up an Email Ingestion Integration in Everbridge Suite

lock-solid.svg

Topic:

How to set up an email ingestion integration in Everbridge Suite.

Description:

Email Ingestion functionality provides administrators with the capability to set up an integration between Everbridge Suite and a third-party alerting application such as event monitoring tools, digital signage software, CAD systems, etc.). Everbridge Suite ingests an email from a third-party application, parses the email, and launches an incident.

Email Ingestion is a premium Everbridge feature, and not enabled for all Everbridge organizations by default. Please contact an Everbridge Account Manager to enable this feature.

Note: The incoming emails Everbridge will ingest must be formatted in Plain Text. If emails are received as HTML, all HTML tags will be stripped, and a plain text body will be generated. With this process, all smart characters will be converted into their plain counterparts.

Requirement: Everbridge currently requires you to specify a domain or use a wildcard domain format (e.g., *@yourdomain.com) for email ingestion. You cannot set up ingestion to accept emails from any email address.

Permissions: To configure or edit Email Ingestion, you must use an account with appropriate administrative privileges (typically Organization Admin or Account Admin), and your organization must have API access configured.

Performance: Email ingestion relies on email delivery and processing, which can introduce some latency between the third-party system sending the email and the incident being created in Everbridge.

Video:

00:05: This tutorial guides you through setting up an email ingestion integration in everbridge

00:17: Click the settings menu to access configuration options.

00:22: Click everbridge open to proceed to integration management.

00:26: Click new integration to start creating a new email ingestion integration.

00:31: Click the integration name field to specify your integration's name.

00:35: Enter your integration name to identify this email integration?

00:40: Enter the Sent From email address.

00:44: enter the custom text

00:48: Click add to include the custom text in your integration settings.

00:52: Click the drop-down to select email subject, email body or text attachments. In this example we will select Email Body

00:58: Choose Condition filter. In this example we will select Contains.

01:05: Click here to enter the filter keyword for your email integration. In this example we type Hurricane

01:09: Click select an incident template to choose a predefined template for your integration.

01:15: Select the incident template from the list. In this example we have selected the Test Incident 1 Template.

01:20: Click OK

01:24: Click override template options to customize template Behavior.

01:28: Click the box to activate the override template options feature.

01:32: Click the drop-down to select override options such as email subject email body or text attachments.

01:38: Click the condition dropdown to select filters. Like contains exactly matches starts with ends with or does not contain for overrides.

01:46: Click here to enter the override filter keyword.

01:50: Click test variables to review and configure variables used in your integration. Use this to confirm that your Regular Expressions and mappings behave as expected before you enable the integration in production.

01:55: Click the TO field to specify the recipient field for the email.

01:59: Click email body to view or edit the content of the email message.

02:04: Click save to finalize and store your email ingestion integration configuration.

02:09: You have successfully configured an email integration.

02:15: If incidents are being created from irrelevant emails, return to Settings > Everbridge Open > Email Ingestion, click the pencil icon next to the integration, and refine the configuration. Make sure the WHEN AN EMAIL IS fields (Sent from / And received at) are correct, and add or adjust filters under AND MEETS (for example, specific subject keywords or body text patterns) so that only appropriate messages trigger incidents.

02:25: To understand why certain emails are triggering incidents, click the Emails Received number for the integration to review the list of processed messages. Use this list to tune your WHEN AN EMAIL IS and AND MEETS conditions, then click Save to apply your changes.

02:35: If you cannot see or edit Email Ingestion settings, confirm that you are logged in with an account that has appropriate administrative permissions (typically Organization Admin or Account Admin), that your organization has API access enabled, and—if you have multiple roles—that you have switched to a role with email ingestion edit privileges. If you still cannot access or modify the integration, contact Everbridge Technical Support to verify your account and organization settings.

Written:

  1. Log in to the Manager Portal and select the appropriate organization from the drop-down menu in the upper right-hand corner.

  2. Select Settings from the top menu bar.

  3. Select Everbridge Open from the drop-down menu.

  4. Select Email Ingestion from the menu on the left.

  5. Select + New Integration.

  6. Enter an Integration Name.

  7. Fill in the fields under WHEN AN EMAIL IS. Note: Both items are case sensitive.

    1. Sent from: Specify a domain or use a wildcard domain format (e.g., *@yourdomain.com)

    2. And received at: Enter the custom text.

  8. Define the conditions for the incoming email under AND MEETS. Note: You can only define the conditions that meet ALL requirements, or only conditions that meet ANY requirements, or meets both ALL and ANY requirements. If no conditions are defined in AND MEETS, every email that matches the basic WHEN AN EMAIL IS criteria will create an incident.

  9. From LAUNCH THE INCIDENT, click the Select an incident template link

  10. Select an Incident Template.

  11. Variables that are required in the Incident template must be mapped. You cannot clear the check box. The check boxes of optional Variables can be cleared. You do not have to map optional Variables. You can map an optional Variable by selecting the check box.

  12. (Optional) Test Variables: Select the Test Variables link to test your Regular Expressions (For further information on Regular Expressions, please access the Everbridge Support Center).

  1. Click Save or Click OK.

  2. Send test email to verify the Success or Failure of your integration.

Was this article helpful?
0 out of 0 found this helpful