List Amazon SNS integrations

Returns a list of all your Amazon SNS integrations. This endpoint supports pagination.

GET https://uptime.betterstack.com/api/v2/amazon-sns

Query parameters

team_name

string

Filter integrations belonging to a specified team when using global API token.

Headers

Authorization

required string

Bearer $TOKEN

200

Returns a list of existing Amazon SNS integrations.

Response body

{
  "data": [
    {
      "id": "4",
      "type": "amazon_sns_integration",
      "attributes": {
        "name": "Backend alerts",
        "created_at": "2026-09-09T10:06:12.418Z",
        "updated_at": "2026-09-09T10:06:31.902Z",
        "policy_id": null,
        "url": "https://uptime.betterstack.com/api/v1/incoming-webhook/[token]",
        "sample_query_string": null,
        "sample_headers": null,
        "sample_body": null,
        "team_name": "Testing",
        "call": false,
        "sms": false,
        "email": true,
        "push": true,
        "critical_alert": false,
        "team_wait": 180,
        "recovery_period": 0,
        "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": "body",
          "match_type": "match_everything",
          "target_field": null,
          "content": null,
          "content_before": null,
          "content_after": null
        },
        "title_field": {
          "name": null,
          "special_type": "title",
          "field_target": "sns_envelope",
          "match_type": "match_everything",
          "target_field": "Subject",
          "content": null,
          "content_before": null,
          "content_after": null
        },
        "started_alert_id_field": {
          "name": null,
          "special_type": "alert_id",
          "field_target": "body",
          "match_type": "match_everything",
          "target_field": null,
          "content": null,
          "content_before": null,
          "content_after": null
        },
        "acknowledged_alert_id_field": null,
        "resolved_alert_id_field": null,
        "other_started_fields": null,
        "other_acknowledged_fields": null,
        "other_resolved_fields": null,
        "topic_arn": "arn:aws:sns:eu-west-1:123456789012:backend-alerts",
        "subscription_state": "active"
      }
    }
  ],
  "pagination": {
    "first": "https://uptime.betterstack.com/api/v2/amazon-sns?page=1",
    "last": "https://uptime.betterstack.com/api/v2/amazon-sns?page=1",
    "prev": null,
    "next": null
  }
}

Response attributes

string

The ID of the Amazon SNS integration.

type

string

Always amazon_sns_integration.

attributes.name

string or null

The name of the Amazon SNS integration shown in the dashboard.

attributes.created_at

string

When the integration was created, as an ISO 8601 timestamp.

attributes.updated_at

string

When the integration was last updated, as an ISO 8601 timestamp.

attributes.policy_id

string or null

ID of the escalation policy for incidents from this integration, or null when incidents alert the on-call person directly.

attributes.url

string

The endpoint to subscribe your Amazon SNS topic to. Read-only.

attributes.sample_query_string

string or null

The query string of the sample notification saved in the dashboard to test extraction. Read-only.

attributes.sample_headers

string or null

The headers of the sample notification saved in the dashboard. Read-only.

attributes.sample_body

string or null

The body of the sample notification saved in the dashboard. Read-only.

attributes.team_name

string

The team this integration belongs to.

attributes.call

boolean

Whether to call the on-call person.

attributes.sms

boolean

Whether to send an SMS to the on-call person.

attributes.email

boolean

Whether to send an e-mail to the on-call person.

attributes.push

boolean

Whether to send a push notification to the on-call person.

attributes.critical_alert

boolean

Whether to send a critical push notification that ignores the mute switch and Do Not Disturb mode.

attributes.team_wait

integer or null

How long we wait before escalating the incident to the team, in seconds. null never escalates to the team and 0 alerts the whole team right away.

attributes.recovery_period

integer

How long the alert must be up to automatically mark an incident as resolved, in seconds.

attributes.paused

boolean

Whether the Amazon SNS integration is paused.

attributes.started_rule_type

string

When notifications start an incident: unused always, any when at least one of started_rules matches, or all when all of them match.

attributes.acknowledged_rule_type

string

When notifications acknowledge an incident: unused never, any when at least one of acknowledged_rules matches, or all when all of them match.

attributes.resolved_rule_type

string

When notifications resolve an incident: unused never, any when at least one of resolved_rules matches, or all when all of them match.

attributes.started_rules

array

The conditions started_rule_type checks, as rule objects with the keys below. Creating an Amazon SNS integration explains each setting.

attributes.started_rules[].created_at

string

When the rule was created, as an ISO 8601 timestamp.

attributes.started_rules[].updated_at

string

When the rule was last updated, as an ISO 8601 timestamp.

attributes.started_rules[].rule_target

string

Which part of the notification the rule checks: sns_envelope for the envelope, body, json, or xml for the message your publisher sent, or query_string or header for AWS's own HTTPS request, which never contains your message.

attributes.started_rules[].target_field

string or null

Which value the rule reads, such as a JSON path, a header name, or a CSS selector. For sns_envelope, one of TopicArn, MessageId, or Subject.

attributes.started_rules[].match_type

string

How the value is compared with content: contains, contains_not, equals, equals_not, matches_regex, or matches_regex_not.

attributes.started_rules[].content

string

The value to compare with, or a regular expression for the regex match types.

attributes.acknowledged_rules

array

The conditions acknowledged_rule_type checks, as rule objects with the same keys as started_rules.

attributes.resolved_rules

array

The conditions resolved_rule_type checks, as rule objects with the same keys as started_rules.

attributes.cause_field

object or null

How the incident cause is extracted, as a field object with the keys below, or null when none is set.

attributes.cause_field.name

string or null

The metadata key of a custom field, or null for the special fields.

attributes.cause_field.special_type

string or null

cause, title, or alert_id for the special fields, or null for a custom field.

attributes.cause_field.field_target

string

Which part of the notification is read: sns_envelope for the envelope, body, json, or xml for the message your publisher sent, or query_string or header for AWS's own HTTPS request, which never contains your message.

attributes.cause_field.target_field

string or null

Which value is read, such as a JSON path, a header name, or a CSS selector. For sns_envelope, one of TopicArn, MessageId, or Subject.

attributes.cause_field.match_type

string

What is extracted: match_everything, match_before, match_after, match_between, or match_regex.

attributes.cause_field.content

string or null

The text to extract around for match_before and match_after, or the regular expression for match_regex.

attributes.cause_field.content_before

string or null

Where extraction starts for match_between.

attributes.cause_field.content_after

string or null

Where extraction stops for match_between.

attributes.title_field

object or null

How a custom incident title is extracted, as a field object like cause_field, or null to use the default title.

attributes.started_alert_id_field

object or null

How the alert ID is extracted from the notification that starts an incident, as a field object like cause_field. Later notifications acknowledge and resolve the incident by matching it.

attributes.acknowledged_alert_id_field

object or null

How the alert ID is extracted from a notification that acknowledges an incident, as a field object like cause_field.

attributes.resolved_alert_id_field

object or null

How the alert ID is extracted from a notification that resolves an incident, as a field object like cause_field.

attributes.other_started_fields

array or null

Extra values extracted into incident metadata when an incident starts, as field objects like cause_field, or null when there are none.

attributes.other_acknowledged_fields

array or null

Extra values extracted into incident metadata when an incident is acknowledged, or null when there are none.

attributes.other_resolved_fields

array or null

Extra values extracted into incident metadata when an incident is resolved, or null when there are none.

attributes.topic_arn

string or null

The ARN of the subscribed Amazon SNS topic, or null until AWS confirms the subscription. Read-only.

attributes.subscription_state

string

awaiting until AWS confirms the subscription, then active. Read-only.

Explore documentation

Example cURL

Explore documentation

List Amazon SNS integrations

Example cURL

Please accept cookies