Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    1. Get started
    2. Post mortems
    3. Metadata & Catalog
    4. Screening alerts
    5. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Incidents API
    1. Getting an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
    5. Status pages
    6. Metadata
    7. Integrations
      1. New Relic
      2. Datadog
      3. AWS CloudWatch
      4. Amazon SNS
      5. Microsoft Azure
      6. Google Monitoring
      7. Grafana
      8. Elastic
      9. Prometheus
      10. E-mail
        1. List e-mail integrations GET
        2. Get e-mail integration GET
        3. Create e-mail integration POST
        4. Update e-mail integration PATCH
        5. Remove e-mail integration DELETE
        6. Response attributes
      11. Incoming webhooks
      12. Atlassian Jira
      13. Slack
      14. Outgoing webhooks
      15. Outgoing e‑mails
      16. Splunk On-Call
      17. PagerDuty
      18. Catalog
    8. Team members
    9. Organization roles
    10. Usage
    11. Reporting

Create e-mail integration

Returns either a newly created e-mail integration, or validation errors.

POST https://incidents.betterstack.com/api/v2/email-integrations

Headers

Authorization
required string

Bearer $TOKEN

Content-Type
string

application/json

Body parameters

team_name
string

Required if using global API token to specify the team which should own the resource

name
string

The name of the e-mail integration that you can see in the dashboard.

*

Any other params you'd like to set. See the list of all e-mail integration API parameters for details.

201

Returns newly created e-mail integration

Response body

{
  "data": {
    "id": "13756",
    "type": "email_integration",
    "attributes": {
      "name": "Test",
      "created_at": "2023-01-19T11:20:50.675Z",
      "updated_at": "2023-01-19T11:20:50.675Z",
      "policy_id": null,
      "call": false,
      "sms": false,
      "email": true,
      "push": true,
      "team_wait": null,
      "recovery_period": 180,
      "email_address": "test@incidents.uptime.betterstack.com",
      "paused": false,
      "started_rule_type": "unused",
      "acknowledged_rule_type": "unused",
      "resolved_rule_type": "unused",
      "started_rules": [],
      "acknowledged_rules": [],
      "resolved_rules": [],
      "cause_field": {
        "name": null,
        "special_type": "cause",
        "field_target": "subject",
        "match_type": "match_everything",
        "content": null,
        "content_before": null,
        "content_after": null
      },
      "started_alert_id_field": null,
      "acknowledged_alert_id_field": null,
      "resolved_alert_id_field": null,
      "other_started_fields": null,
      "other_acknowledged_fields": null,
      "other_resolved_fields": null
    }
  }
}

Example cURL

Example
curl -X "POST" "https://incidents.betterstack.com/api/v2/email-integrations/" \
     -H "Authorization: Bearer $TOKEN" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "name": "Test"
}'


Previous article

Get e-mail integration

Next article

Update e-mail integration