Email Integration Guide | PagerDuty

This guide describes how to integrate PagerDuty with any service capable of sending email alerts. Please note that we offer integration guides and plugins for many popular monitoring services. Furthermore, tools that don’t yet have dedicated guides can often be integrated with PagerDuty using our Events API.

How it Works

Events and alerts from monitoring tools will be sent as emails to your desired email address. PagerDuty will open and trigger an incident when it receives an email to this integration address.

Requirements

  • This integration requires a User, Admin, Manager, Global Admin or Account Owner role to configure.
  • You must have a monitoring tool that supports sending email alerts.
  • You must have one of the following configured based on your integration preferences:
    • Ruleset: Integrating with Rulesets may be beneficial if you want to build different routing rules based on the events coming from the integrated tool.
    • Event Orchestration: Integrating with Event Orchestrations may be beneficial if you want to build nested rules based on the events coming from the integrated tool.
    • PagerDuty Service: Integrating with a PagerDuty service directly can be beneficial if you don’t need to route alerts from the integrated tool to different responders based on the event payload.

Integration Walkthrough

In PagerDuty

There are three ways to integrate with a PagerDuty email address:

Integrating With Rulesets

  1. From the Automation menu, select Event Rules and then click your Default Global Ruleset.
  2. Click Incoming Event Source, copy your Email Address and then refer to your monitoring tool’s documentation on connecting with an email address in order to complete the integration. PagerDuty will open and trigger an incident when it receives an email to this integration address. The Email Incident Example section displays a screenshot of what a test incident will look like.

Integrating with Event Orchestrations

  1. From the Automation menu, select Event Orchestration and then click your preferred Global Orchestration.
  2. Click the Global Orchestration Key dropdown, copy your Email Address and then refer to your monitoring tool’s documentation on connecting with an email address in order to complete the integration. PagerDuty will open and trigger an incident when it receives an email to this integration address. The Email Incident Example section displays a screenshot of what a test incident will look like.

Integrating with a PagerDuty Service

  1. From the Services menu, select Service Directory.
  2. Click the name of the service you want to add the integration to. Then select the Integrations tab and click Add an integration.
  3. Search and select Email from the Select the integration(s) you use to send alerts to this service dropdown.
  4. Click Add to save your new integration. You will be redirected to the Integrations tab for your service.
  5. Find your integration in the list and click to the right. Copy the Integration Email address and refer to your monitoring tool’s documentation on connecting with an email address in order to complete the integration. PagerDuty will open and trigger an incident when it receives an email to this integration address.

Email Incident Example

Below is a test incident triggered via email:

Email Management

By default, PagerDuty opens a new incident every time an email is received at the integration address. You can change this behavior by changing the Email Management setting for your service. See Trigger and Resolve Alerts with Email Management Rules for more information.

Email Filters

Filters allow you to disregard certain messages arriving at the integration email address. Each email’s subject, body, and from address can be checked against either a safelist or blocklist regular expression filter. Messages that don’t pass the filter will be silently discarded. This feature is handy if you have a monitoring tool that sends out emails that you don’t want to trigger incidents in PagerDuty. See Advanced Email Management: Extracting Information with Regular Expressions for more information on email filters.

TLS encrypted emails

PagerDuty email servers are configured to accept TLS protected SMTP sessions when your outbound mail servers are configured to use TLS opportunistically. When the message is encrypted, the last hop listed in the receive headers will mention a TLS-enabled connection.

Email Attachments and Truncation of Emails

PagerDuty strips all attachments from emails and also truncates messages. If the email (including headers, attachments, etc.) is under 96 KB, the message can pass through without truncation. If the message is over 96 KB, the following can happen:

  1. Any parts of the email body where the Content-Type is not matched by this regular expression will be discarded:
    /(text\/(plain|html)|multipart\/)/
    This means PDF files and similar attachments will be stripped.
  2. Text parts (Content-Type of text/plain or text/html) will be truncated to 32 KB.
  3. If the resulting total email size (including headers, attachments, etc.) still exceeds 192 KB then PagerDuty will reject the message.

You can tell if a message has been truncated or had attachments removed by checking for the headers X-PagerDuty-Truncated-Part or X-PagerDuty-Removed-Attachments when viewing the raw message. You can view the raw message on the incident's detail page by clicking View Message on an incident log entry, then View Raw Message.

See Email Notifications for more details on email content and behavior.

Email Size Limits

If an email is over 10 MB, our server will reject it.

Incident Key Truncation

If the incident key of the email that triggered an incident is more than 255 characters it will be truncated to 255 characters.

Truncation of Incident Details in Email Notifications

When you receive a PagerDuty email notification, the Details section of each incident will be truncated to 500 characters. That said, the entire email body is accessible in the PagerDuty web app via the incident logs and details, or via the mobile app.


Did this page help you?