Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
    4. Incident silencing
    5. Incident metadata
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  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. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
    2. On-call calendar events
    3. Escalation policies
    4. Escalation policy groups
    5. Severities
    6. Severity groups
    7. Incidents
    8. Comments
  12. Integrations API
    1. New Relic Integrations
    2. Datadog Integrations
    3. AWS CloudWatch Integrations
    4. Azure Integrations
    5. Google Monitoring Integrations
    6. Grafana Integrations
    7. Prometheus Integrations
    8. Email integrations
      1. List all email integrations GET
      2. Get a single email integration GET
      3. Create an email integration POST
      4. Update an email integration PATCH
      5. Delete an email integration DELETE
      6. Email integration API response params
    9. Incoming webhooks
    10. Slack Integrations
    11. Outgoing Webhook integrations
    12. Splunk On-Call integrations
    13. PagerDuty Integrations
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
    5. Status page report updates
  14. Other API
    1. Metadata

Create an 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 a single email integration

Next article

Update an email integration