Returns a single e-mail integration by ID.
URL parameters
The ID of the e-mail integration you want to get.
Headers
Bearer $TOKEN
Returns a single e-mail integration.
Response body
Response attributes
The ID of the e-mail integration.
Always email_integration.
The name of the e-mail integration shown in the dashboard.
When the integration was created, as an ISO 8601 timestamp.
When the integration was last updated, as an ISO 8601 timestamp.
ID of the escalation policy for incidents from this integration, or null when incidents alert the on-call person directly.
The team this integration belongs to.
Whether to call the on-call person.
Whether to send an SMS to the on-call person.
Whether to send an e-mail to the on-call person.
Whether to send a push notification to the on-call person.
Whether to send a critical push notification that ignores the mute switch and Do Not Disturb mode.
How long we wait before escalating the incident to the team, in seconds. null never escalates to the team and 0 alerts the whole team right away.
How long to wait after an e-mail matching resolved_rules arrives before marking an incident as resolved, in seconds. Has no effect while resolved_rule_type is unused.
The address to forward your e-mails to. Read-only.
Whether the e-mail integration is paused.
When e-mails start an incident: unused always, any when at least one of started_rules matches, or all when all of them match.
When e-mails acknowledge an incident: unused never, any when at least one of acknowledged_rules matches, or all when all of them match.
When e-mails resolve an incident: unused never, any when at least one of resolved_rules matches, or all when all of them match.
The conditions started_rule_type checks, as rule objects with the keys below. Creating an e-mail integration explains each setting.
When the rule was created, as an ISO 8601 timestamp.
When the rule was last updated, as an ISO 8601 timestamp.
Which part of the e-mail the rule checks: from_email, subject, or body.
How the value is compared with content: contains, contains_not, equals, equals_not, matches_regex, or matches_regex_not.
The value to compare with, or a regular expression for the regex match types.
The conditions acknowledged_rule_type checks, as rule objects with the same keys as started_rules.
The conditions resolved_rule_type checks, as rule objects with the same keys as started_rules.
How the incident cause is extracted, as a field object with the keys below, or null when none is set.
The metadata key of a custom field, or null for the special fields.
cause, title, or alert_id for the special fields, or null for a custom field.
Which part of the e-mail is read: from_email, subject, or body.
What is extracted: match_everything, match_before, match_after, match_between, or match_regex.
The text to extract around for match_before and match_after, or the regular expression for match_regex.
Where extraction starts for match_between.
Where extraction stops for match_between.
How a custom incident title is extracted, as a field object like cause_field, or null to use the default title.
How the alert ID is extracted from the e-mail that starts an incident, as a field object like cause_field. Later e-mails acknowledge and resolve the incident by matching it.
How the alert ID is extracted from an e-mail that acknowledges an incident, as a field object like cause_field.
How the alert ID is extracted from an e-mail that resolves an incident, as a field object like cause_field.
Extra values extracted into incident metadata when an incident starts, as field objects like cause_field, or null when there are none.
Extra values extracted into incident metadata when an incident is acknowledged, or null when there are none.
Extra values extracted into incident metadata when an incident is resolved, or null when there are none.
We use cookies to authenticate users, improve the product user experience, and for personalized ads. Learn more.