Get outgoing e-mail

Returns a single outgoing e-mail integration by ID.

GET https://incidents.betterstack.com/api/v2/outgoing-emails/{integration_id}

URL parameters

integration_id
required string

Headers

Authorization
required string
200

Response body

{
  "data": {
    "id": "42",
    "type": "outgoing_email",
    "attributes": {
      "name": "Client distribution list",
      "recipients": [
        {
          "email": "ops@client.com",
          "first_name": "Sam",
          "team": "SRE"
        },
        {
          "email": "noc@client.com"
        }
      ],
      "team_name": "My team",
      "paused": false,
      "notify_alongside_primary_responder": true,
      "on_incident_started": true,
      "on_incident_acknowledged": false,
      "on_incident_resolved": true,
      "on_incident_reopened": true,
      "on_incident_comment": false,
      "templates": [
        {
          "incident_stage": "started",
          "subject": "Incident: $NAME",
          "title": "We're investigating an issue with $NAME",
          "body": "Hi $RECIPIENT.first_name, we detected a problem: $CAUSE. Follow along at $INCIDENT_URL."
        }
      ]
    }
  }
}

Example cURL

Example
curl --request GET \
  --url https://incidents.betterstack.com/api/v2/outgoing-emails/42 \
  --header "Authorization: Bearer $TOKEN"