Squadcast is now SolarWinds Incident Response
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Extensions/MSTeams

Get MSTeams Config

get
/v3/extensions/msteams/config

Returns MSTeams config of the organization. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
authorizationstringRequired
Responses
200

The request has succeeded.

application/json
get/v3/extensions/msteams/config
GET /v3/extensions/msteams/config HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Accept: */*
{
  "data": {
    "custom_incident_alert_state": {
      "is_trigger_active": true,
      "is_retrigger_active": true,
      "is_acknowledge_active": true,
      "is_resolve_active": true,
      "is_reassign_active": true,
      "is_notes_added_active": true,
      "is_postmortem_active": true,
      "is_priority_updated_active": true
    },
    "id": "text",
    "organization_id": "text",
    "default_conversation_name": "text",
    "default_conversation_id": "text",
    "is_active": true,
    "is_default_active": true,
    "is_custom_channels_active": true,
    "triggers": {
      "all_active": true,
      "custom": [
        "text"
      ]
    },
    "tenant_id": "text",
    "from_id": "text",
    "connected_teams": [
      {
        "id": "text",
        "team_id": "text",
        "team_name": "text",
        "channel_configurations": [
          {
            "id": "text",
            "squadcast_team_id": "text",
            "squadcast_team_name": "text",
            "is_all_services": true,
            "services": [
              {
                "squadcast_service_id": "text",
                "squadcast_service_name": "text"
              }
            ],
            "msteams_channel_id": "text",
            "msteams_channel_name": "text"
          }
        ]
      }
    ]
  }
}

Create Or Update MSTeams Configuration

post
/v3/extensions/msteams/config

Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
authorizationstringRequired
Body

The request body for creating or updating an MS Teams extension configuration.

idstringOptional

The MongoDB ObjectID of the extension document. Should be included for updates.

organization_idstringOptional

The MongoDB ObjectID of the organization this extension belongs to.

default_conversation_namestringRequired

The display name for the default conversation/channel.

default_conversation_idstringRequired

The unique identifier for the default MS Teams conversation/channel.

is_activebooleanRequired

A master switch to enable or disable the entire integration.

is_default_activebooleanRequired

Determines if notifications should be sent to the default channel.

is_custom_channels_activebooleanRequired

Determines if notifications should be sent to custom-configured channels.

tenant_idstringRequired

The Azure AD Tenant ID of the organization that owns this extension.

from_idstringRequired

The Azure AD Object ID of the user who created this extension.

Responses
200

The request has succeeded.

application/json
post/v3/extensions/msteams/config
POST /v3/extensions/msteams/config HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 846

{
  "custom_incident_alert_state": {
    "is_trigger_active": true,
    "is_retrigger_active": true,
    "is_acknowledge_active": true,
    "is_resolve_active": true,
    "is_reassign_active": true,
    "is_notes_added_active": true,
    "is_postmortem_active": true,
    "is_priority_updated_active": true
  },
  "id": "text",
  "organization_id": "text",
  "default_conversation_name": "text",
  "default_conversation_id": "text",
  "is_active": true,
  "is_default_active": true,
  "is_custom_channels_active": true,
  "triggers": {
    "all_active": true,
    "custom": [
      "text"
    ]
  },
  "tenant_id": "text",
  "from_id": "text",
  "connected_teams": [
    {
      "id": "text",
      "team_id": "text",
      "team_name": "text",
      "channel_configurations": [
        {
          "id": "text",
          "squadcast_team_id": "text",
          "squadcast_team_name": "text",
          "is_all_services": true,
          "services": [
            {
              "squadcast_service_id": "text",
              "squadcast_service_name": "text"
            }
          ],
          "msteams_channel_id": "text",
          "msteams_channel_name": "text"
        }
      ]
    }
  ]
}
{
  "data": {
    "custom_incident_alert_state": {
      "is_trigger_active": true,
      "is_retrigger_active": true,
      "is_acknowledge_active": true,
      "is_resolve_active": true,
      "is_reassign_active": true,
      "is_notes_added_active": true,
      "is_postmortem_active": true,
      "is_priority_updated_active": true
    },
    "id": "text",
    "organization_id": "text",
    "default_conversation_name": "text",
    "default_conversation_id": "text",
    "is_active": true,
    "is_default_active": true,
    "is_custom_channels_active": true,
    "triggers": {
      "all_active": true,
      "custom": [
        "text"
      ]
    },
    "tenant_id": "text",
    "from_id": "text",
    "connected_teams": [
      {
        "id": "text",
        "team_id": "text",
        "team_name": "text",
        "channel_configurations": [
          {
            "id": "text",
            "squadcast_team_id": "text",
            "squadcast_team_name": "text",
            "is_all_services": true,
            "services": [
              {
                "squadcast_service_id": "text",
                "squadcast_service_name": "text"
              }
            ],
            "msteams_channel_id": "text",
            "msteams_channel_name": "text"
          }
        ]
      }
    ]
  }
}

Last updated