Update Slack integration

Update an existing Slack integration. Every setting on the integration's Configure page can be changed here. Send only the parameters you wish to change, e.g. integration_type. Lists like alert_options replace the whole list.

Connecting Slack needs a sign-in to your Slack workspace, so connect the integration in the Better Stack dashboard first.

PATCH 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 update.

Headers

Authorization

required string

Bearer $TOKEN

Content-Type

required string

application/json

Body parameters

integration_type

string

How incidents are posted. verbose posts every incident to the single connected channel, thread starts a thread per incident in it, and channel creates a new channel per incident. thread and channel need a paid plan.

channel_invitees

array

Who to always invite into the incident channel when integration_type is channel. An array of objects with a type and an id. type is user, on_call_calendar, or slack_user_group.

private_channel

boolean

Make the incident channels private. Needs at least one entry in channel_invitees.

channel_display_name

string

The name shown for the connected channel in Better Stack. Send null to show the channel's own name.

alert_all_teams_and_policies

boolean

Let Slack users alert every team and escalation policy. Set it to false to allow only the ones in alert_options.

alert_options

array

The teams and escalation policies Slack users can alert. A team is {"type": "team", "id": 7} with the booleans call, sms, email, push and critical_alert, each false when left out. An escalation policy is {"type": "policy", "id": 73}. The read-only keys a GET returns, name, team_id and team_name, are ignored, so you can send the alert_options from a GET back unchanged.

invite_new_slack_users

boolean

Invite new Slack users into your Better Stack team as responders.

on_call_notifications

boolean

Notify the channel when the primary responder changes.

notify_on_pause

boolean

Notify when a resource is paused.

notify_on_resolve

boolean

Notify when an incident is resolved.

direct_message_on_mention

boolean

Send a direct message to people tagged in incident comments.

ai_sre_on_mention

boolean

Start an AI SRE conversation when Better Stack is tagged.

restrict_incident_creation_to_channel

boolean

Allow creating incidents only by the members of the connected channel.

post_timeline_events

boolean

Post incident timeline events about e-mails, phone calls, and integrations. Applies when integration_type is thread or channel.

post_incident_metadata

boolean

Post incident metadata.

post_status_page_updates

boolean

Post status page updates. Turning it off clears status_page_update_resources.

status_page_update_resources

array

Post status page updates only for these affected resources, given as objects with a type and an id, or leave it empty to post updates for every resource of the integration's team. Needs post_status_page_updates turned on, and type is 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.

notify_alongside_primary_responder

boolean

Notify this integration alongside the primary responder when no escalation policy is configured.

200

Returns the updated Slack integration

Response body

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

422

Returned when a value can't be applied, e.g. a team outside your organization. The error names the parameter.

Response body

{
  "errors": {
    "alert_options": [
      "Team 8 was not found."
    ]
  }
}

422

Returned when the change needs a feature your plan doesn't include, e.g. thread or channel mode.

Response body

{
  "errors": "Thread-based and channel-based Slack integrations need a paid plan.",
  "unauthorized_attributes": [
    "integration_type"
  ]
}

Example cURL

Create a channel per incident Allow only e-mail and push alerts

Copied!

curl -X "PATCH" "https://incidents.betterstack.com/api/v2/slack-integrations/37" \
     -H "Authorization: Bearer $TOKEN" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "integration_type": "channel",
  "private_channel": true,
  "channel_invitees": [{ "type": "on_call_calendar", "id": 1 }]
}'

curl -X "PATCH" "https://incidents.betterstack.com/api/v2/slack-integrations/37" \
     -H "Authorization: Bearer $TOKEN" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "alert_all_teams_and_policies": false,
  "alert_options": [
    { "type": "team", "id": 7, "email": true, "push": true },
    { "type": "policy", "id": 73 }
  ]
}'

Get Slack integration

List outgoing webhooks

Explore documentation

Update Slack integration

Example cURL

Please accept cookies