Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced guide
  5. Incidents
    1. Get started
    2. Advanced guide
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
    4. Migrating to pay as you go
  9. Uptime API
    1. Get 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. Microsoft Azure
      5. Google Monitoring
      6. Grafana
      7. Elastic
      8. Prometheus
      9. Email
        1. List email integrations GET
        2. Get email integration GET
        3. Create email integration POST
        4. Update email integration PATCH
        5. Remove email integration DELETE
        6. Response attributes
      10. Incoming webhooks
      11. Atlassian Jira
      12. Slack
      13. Outgoing webhooks
      14. Splunk On-Call
      15. PagerDuty
      16. Catalog

Create email integration

Returns either a newly created email integration, or validation errors.

POST https://uptime.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 email integration that you can see in the dashboard.

*

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

201

Returns newly created email 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://uptime.betterstack.com/api/v2/email-integrations/" \
     -H "Authorization: Bearer $TOKEN" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "name": "Test"
}'

Previous article

Get email integration

Next article

Update email integration