Explore documentation
Response attributes
Namespace data
| Parameter | Type | Value |
|---|---|---|
id |
String | The ID of the outgoing e-mail integration. String representation of a number. |
type |
String | outgoing_email |
attributes |
Object | Attributes object. Contains all the outgoing e-mail integration attributes. See below. |
attributes.name |
String | Name of the outgoing e-mail integration. |
attributes.recipients |
Array | The recipients that receive incident e-mails. Each entry is a flat object with an email key plus any custom attribute keys you added. See below. |
attributes.recipients[].email |
String | The recipient e-mail address. |
attributes.team_name |
String | The team this integration belongs to. |
attributes.paused |
Boolean | Whether the integration is paused. Paused integrations don't send e-mails. |
attributes.notify_alongside_primary_responder |
Boolean | Whether recipients are notified alongside the primary responder when no escalation policy is configured. |
attributes.on_incident_started |
Boolean | Whether an e-mail is sent when an incident starts. |
attributes.on_incident_acknowledged |
Boolean | Whether an e-mail is sent when an incident is acknowledged. |
attributes.on_incident_resolved |
Boolean | Whether an e-mail is sent when an incident is resolved. |
attributes.on_incident_reopened |
Boolean | Whether an e-mail is sent when an incident is reopened. |
attributes.on_incident_comment |
Boolean | Whether an e-mail is sent when a new comment is added to an incident. |
attributes.templates |
Array | The per-event message templates. Each entry customizes the e-mail for one incident stage. See below. |
Besides email, each recipient object also carries any custom attribute keys you added, for example first_name or team. Insert them into templates with $RECIPIENT.<key>.
Templates
| Parameter | Type | Value |
|---|---|---|
incident_stage |
String | The event the template applies to. One of started, acknowledged, resolved, reopened, comment. |
subject |
String | The e-mail subject line. Supports variables such as $NAME, $STATUS, and $RECIPIENT.<key>. |
title |
String | The e-mail title. Supports the same variables as subject. |
body |
String | The e-mail body. Supports the same variables as subject. |