Headers
Bearer $TOKEN
application/json
Body parameters
Required if using global API token to specify the team which should own the resource
The name of the e-mail integration that you can see in the dashboard.
ID of the escalation policy for incidents from this integration. Without one, incidents alert the current on-call person through the channels set by call, sms, email, and push.
Call the on-call person.
Send an SMS to the on-call person.
Send an e-mail to the on-call person.
Send a push notification to the on-call person.
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. Send null to never escalate to the team, or 0 to alert 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: 0, 60, 180, 300, 900, 1800, 3600, or 7200. Has no effect while resolved_rule_type is unused.
Set to true to pause the integration, false to unpause it.
When e-mails start an incident: unused always, any when at least one of started_rules matches, or all when all of them match. Defaults to unused.
When e-mails acknowledge an incident: unused never, any when at least one of acknowledged_rules matches, or all when all of them match. Defaults to unused, and any other value requires started_alert_id_field and acknowledged_alert_id_field.
When e-mails resolve an incident: unused never, any when at least one of resolved_rules matches, or all when all of them match. Defaults to unused, and any other value requires started_alert_id_field and resolved_alert_id_field.
The conditions started_rule_type checks, as an array of rule objects with the keys below. At least one rule is required when the type is any or all.
Which part of the e-mail the rule checks: from_email, subject, or body.
How to compare the value with content: contains, contains_not, equals, equals_not, matches_regex, or matches_regex_not.
The value to compare with. Must be a valid regular expression for matches_regex and matches_regex_not.
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 to extract the incident cause from the e-mail that starts an incident, as a field object with the keys below. Defaults to the whole subject.
Which part of the e-mail to read: from_email, subject, or body.
What to extract: match_everything takes the whole value, match_before the text before content, match_after the text after content, match_between the text between content_before and content_after, and match_regex the match of the regular expression in content, or its capture group.
The text to extract around for match_before and match_after, or the regular expression for match_regex. Required for those three.
Where extraction starts for match_between. Required for match_between.
Where extraction stops for match_between. Leave it empty to extract to the end.
How to extract a custom incident title, as a field object with the same keys as cause_field. Send null to remove it and use the default title.
How to extract the alert ID from the e-mail that starts an incident, with the same keys as cause_field; later e-mails acknowledge and resolve the incident by matching it. Required when acknowledged_rule_type or resolved_rule_type isn't unused.
How to extract the alert ID from an e-mail that acknowledges an incident, with the same keys as cause_field. Required when acknowledged_rule_type isn't unused.
How to extract the alert ID from an e-mail that resolves an incident, with the same keys as cause_field. Required when resolved_rule_type isn't unused.
Extra values to extract when an incident starts, saved as incident metadata. Each field object has the same keys as cause_field, plus name.
The metadata key to save the extracted value under. Must be unique within the array.
Extra values to extract when an incident is acknowledged, with the same keys as other_started_fields.
Extra values to extract when an incident is resolved, with the same keys as other_started_fields.