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. Pagination
    3. Monitors
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
    7. Metadata
    8. 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
      11. Incoming webhooks
      12. Atlassian Jira
      13. Slack
        1. List Slack integrations GET
        2. Get Slack integration GET
        3. Update Slack integration PATCH
      14. Outgoing webhooks
      15. Outgoing e‑mails
      16. Splunk On-Call
      17. PagerDuty
      18. Catalog
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

Get Slack integration

Returns a single Slack integration by ID.

GET https://incidents.betterstack.com/api/v2/slack-integrations/{slack_integration_id}

URL parameters

slack_integration_id
required string

The ID of the Slack integration you want to get.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a single Slack integration.

Response body

{
  "data": {
    "id": "37",
    "type": "slack_integration",
    "attributes": {
      "slack_team_id": "T04UQ7K4QMB",
      "slack_team_name": "My Slack integration",
      "slack_channel_id": "C07Q2KF20EU",
      "slack_channel_name": "#better-stack-incidents",
      "slack_status": "active",
      "integration_type": "channel",
      "on_call_notifications": true,
      "notify_alongside_primary_responder": true,
      "channel_display_name": null,
      "channel_invitees": [
        {
          "type": "on_call_calendar",
          "id": 1
        }
      ],
      "status_page_update_resources": [],
      "private_channel": false,
      "alert_all_teams_and_policies": false,
      "invite_new_slack_users": true,
      "notify_on_pause": true,
      "notify_on_resolve": true,
      "direct_message_on_mention": true,
      "ai_sre_on_mention": true,
      "restrict_incident_creation_to_channel": false,
      "post_timeline_events": true,
      "post_incident_metadata": true,
      "post_status_page_updates": false,
      "team_name": "Testing",
      "alert_options": [
        {
          "type": "policy",
          "id": 73,
          "name": "High severity policy",
          "team_id": 7,
          "team_name": "My team"
        },
        {
          "type": "team",
          "id": 7,
          "name": "My team",
          "call": false,
          "sms": false,
          "email": true,
          "push": false,
          "critical_alert": false
        }
      ]
    }
  }
}

Response attributes

id
string

The ID of the Slack integration.

type
string

Always slack_integration.

attributes.slack_team_id
string

The Slack ID of the connected workspace.

attributes.slack_team_name
string

The name of the connected Slack workspace.

attributes.slack_channel_id
string

The Slack ID of the connected channel.

attributes.slack_channel_name
string

The name of the connected Slack channel.

attributes.slack_status
string

active, or account_inactive when Slack reports the connected account as inactive.

attributes.integration_type
string

How incidents are posted: verbose to the connected channel, thread as a thread per incident, or channel as a channel per incident. legacy integrations predate these modes and behave like verbose.

attributes.on_call_notifications
boolean

Whether to notify the channel when the primary responder changes.

attributes.notify_alongside_primary_responder
boolean

Whether to notify this integration alongside the primary responder when no escalation policy is configured.

attributes.channel_display_name
string or null

The name shown for the connected channel in Better Stack, or null for the channel's own name.

attributes.channel_invitees
array

Who is always invited into the incident channel when integration_type is channel.

attributes.channel_invitees[].type
string

user, on_call_calendar, or slack_user_group.

attributes.channel_invitees[].id
integer

The ID of the user, on-call calendar, or Slack user group.

attributes.status_page_update_resources
array

The affected resources to post status page updates for. Empty means every resource of the integration's team.

attributes.status_page_update_resources[].type
string

One of status_page, monitor, heartbeat, monitor_group, heartbeat_group, webhook_integration, email_integration, incoming_webhook, amazon_sns_integration, manually_tracked_item, logs_chart, or catalog_reference.

attributes.status_page_update_resources[].id
integer

The ID of the resource.

attributes.private_channel
boolean

Whether the incident channels are private.

attributes.alert_all_teams_and_policies
boolean

Whether Slack users can alert every team and escalation policy, or only the ones in alert_options.

attributes.invite_new_slack_users
boolean

Whether new Slack users are invited into your Better Stack team as responders.

attributes.notify_on_pause
boolean

Whether to notify when a resource is paused.

attributes.notify_on_resolve
boolean

Whether to notify when an incident is resolved.

attributes.direct_message_on_mention
boolean

Whether to send a direct message to people tagged in incident comments.

attributes.ai_sre_on_mention
boolean

Whether to start an AI SRE conversation when Better Stack is tagged.

attributes.restrict_incident_creation_to_channel
boolean

Whether only the members of the connected channel can create incidents.

attributes.post_timeline_events
boolean

Whether to post incident timeline events about e-mails, phone calls, and integrations.

attributes.post_incident_metadata
boolean

Whether to post incident metadata.

attributes.post_status_page_updates
boolean

Whether to post status page updates.

attributes.team_name
string

The team this integration belongs to.

attributes.alert_options
array

The teams and escalation policies Slack users can alert.

attributes.alert_options[].type
string

team or policy.

attributes.alert_options[].id
integer

The ID of the team or escalation policy.

attributes.alert_options[].name
string

The name of the team or escalation policy. Read-only.

attributes.alert_options[].team_id
integer

The ID of the policy's team. Returned only for policy and read-only.

attributes.alert_options[].team_name
string

The name of the policy's team. Returned only for policy and read-only.

attributes.alert_options[].call
boolean

Whether Slack users can call the current on-call person. Returned only for team.

attributes.alert_options[].sms
boolean

Whether Slack users can send an SMS to the current on-call person. Returned only for team.

attributes.alert_options[].email
boolean

Whether Slack users can send an e-mail to the current on-call person. Returned only for team.

attributes.alert_options[].push
boolean

Whether Slack users can send a push notification to the current on-call person. Returned only for team.

attributes.alert_options[].critical_alert
boolean

Whether Slack users can send a critical push notification that ignores the mute switch and Do Not Disturb mode. Returned only for team.

Example cURL

Example
curl --request GET \
  --url https://incidents.betterstack.com/api/v2/slack-integrations/37 \
  --header "Authorization: Bearer $TOKEN"


Previous article

List Slack integrations

Next article

Update Slack integration