Events with email is not supported on
If your application does not have an existing Datadog integration, and you don’t want to create a custom Agent check, you can send events with email. This can also be done with messages published to an Amazon SNS topic; read the Create Datadog Events from Amazon SNS Emails guide for more information.
Setup
Before you can send events with email, you need a dedicated email address from Datadog:
- Log in to your Datadog account.
- From the Account menu at the bottom left, select Organization Settings.
- Click the Events API emails tab.
- Choose the format for your messages from the Format dropdown (
Plain text or JSON v2). - Optionally, define any of the other attributes listed in this page’s attribute definitions section.
- Click the Create Email button.
The Events API emails section displays all the emails available for your applications and who created them.
Attribute definitions
| Name | Description | Example |
|---|
| Description | A description of the email’s purpose. | “Used for MyService notifications” |
| Tags | List of tags to be appended to each event received through the email. If other tags are present in the JSON message, they are all added.
There is a limit of 20 tags per email. | tag1:val1, tag2:val2 |
| Recipients | List of handles to be added to the beginning of the message for all events created through the email, without @ prefix. For more information, see Notification recipients.
There is a limit of 10 recipients per email. | my@email.com, slack-acc-ch |
| Alert Type | For Plain text and JSON format addresses, sets the alert type for events. When present, the alert_type field in a JSON email takes precedence over this setting. Not supported for JSON v2—set category and related fields in the email JSON body instead. | Info |
Submission
There are three ways to send events with email, described in the tabs below (JSON, Plain text, and JSON v2). The JSON format is deprecated for new event email addresses—you cannot create new addresses with that format, but existing JSON addresses keep working. For new applications that send JSON-formatted emails, use JSON v2.
If you have complete control over the email sent by an application, then you can send a JSON-formatted message. The email body must follow the JSON shape for Events API v1 (POST /api/v1/events). Select the v1 API version to see the request body fields. The JSON in the email body sets the event fields that show in Datadog.
Source email
With a JSON format email, the following fields are controllable:
- The sender’s email address
- All fields supported by Events API v1 (for example
title, text, tags, and alert_type)
Note: If your JSON is not properly formatted, or the email is sent without a subject, the event doesn’t show in your event stream.
Datadog event
In a JSON format email, the subject of the email doesn’t appear in the event. The value of the title attribute is used for the event title. All data that appears in the event should be defined in JSON in the body of the email. Furthermore, the body must be pure, well-formed JSON—if not, the message is ignored. Example event sent with JSON:
Note: If you are testing the email with a standard email client, the body may be converted to HTML. This causes the body to no longer be pure JSON, resulting in an ignored email.
If you have little control over the email sent by an application, use a plain text formatted message.
Source email
With a plain text formatted email, the following fields are controllable:
| Field | Required | Description |
|---|
| Sender email address | Yes | The email address of the sender |
| Subject | Yes | The subject of the email |
| Body | Yes | The body of the email |
For example, the email below is a valid submission:
Sender's email: matt@datadog.com
Subject: Env:Test - System at 50% CPU - #test
Body: This is a test message showing that env:test is at 50% CPU - #test
Email body processing
The email body goes through several cleanup steps to enhance readability and security. The expected changes include:
- HTML to Markdown: HTML content is converted to its markdown equivalent.
- HTML sanitization: For security, email bodies are sanitized, allowing only specific HTML tags:
a, br, code, div, em, h1, h2, h3, h4, h5, h6, hr, iframe, img,
li, ol, p, pre, span, strong, ul. Any other HTML tag, including strings enclosed in <>, are removed. - Strip reply/forward content: Only the most recent email in a thread is retained, with older replies and forwards removed.
Datadog event
The subject of the email becomes the title of the event and the body of the email becomes the event message. The sender of the email appears at the bottom of the event. Tags can be added by using # in message body. Example event sent with plain text:
If you have complete control over the email sent by an application, then you can send a JSON-formatted message. The email body must follow the JSON shape for Events API v2 (POST /api/v2/events). The JSON in the email body sets the event fields that show in Datadog.
Source email
With a JSON v2 format email, the following fields are controllable:
- The sender’s email address
- All fields supported by Events API v2 (for example
data.attributes.title, data.attributes.message, data.attributes.tags, data.attributes.category)
Example email body for an alert event. Change and info events use different fields under data.attributes.attributes; see the API reference for those categories.
{
"data": {
"attributes": {
"category": "alert",
"title": "CPU threshold exceeded",
"message": "Host prod-web-01 averaged 92% CPU for five minutes.",
"tags": [
"env:production",
"region:us-east"
],
"integration_id": "custom-events",
"attributes": {
"status": "error",
"priority": "3"
}
},
"type": "event"
}
}
Note: If your JSON is not properly formatted, or the email is sent without a subject, the event doesn’t show in your event stream.
Datadog event
In a JSON v2 format email, the subject of the email doesn’t appear in the event. The value of the title field in the JSON body is used for the event title. All data that appears in the event should be defined in JSON in the body of the email. Furthermore, the body must be pure, well-formed JSON—if not, the message is ignored.
Note: If you are testing the email with a standard email client, the body may be converted to HTML. This causes the body to no longer be pure JSON, resulting in an ignored email.
Markdown
Datadog event text supports Markdown but embedding HTML in Markdown is not supported. To use Markdown in the event text, start the text block with %%% \n and end the text block with \n %%%:
{
"title": "Did you hear the news today?",
"text": "%%% \n [an example link](http://example.com/session_id \"Title\") \n %%%",
"priority": "normal",
"tags": ["environment:test"],
"alert_type": "info"
}
If you are embedding a link in a Markdown block, make sure the URL is encoded properly:
# Not encoded
http://example.com/session_id:123456
# Encoded
http://example.com/session_id%3A123456
Email size
The maximum allowed email size, including content and attachments, is 20MB. Emails exceeding this limit are ignored.
Usage tracking
To understand which emails are being used and receiving events, check the Last Used column in the Events API Emails tab in organization settings. This displays the most recent date that an email was processed for each address, or No data if there are no records of it being used.
