Extensions/MSTeams

Get MSTeams Config

get

https://api.eu.squadcast.comhttps://api.squadcast.com

/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

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/extensions/msteams/config

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Msteams.GetConfig(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "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

https://api.eu.squadcast.comhttps://api.squadcast.com

/v3/extensions/msteams/config

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequired

Body

application/json

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

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post

/v3/extensions/msteams/config

Go (SDK)Python (SDK)Typescript (SDK)

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Extensions.Msteams.UpsertConfig(ctx, components.V3ExtensionsMSTeamsCreateOrUpdateMSTeamsConfigRequest{
        DefaultConversationName: "<value>",
        DefaultConversationID: "<id>",
        IsActive: false,
        IsDefaultActive: false,
        IsCustomChannelsActive: true,
        Triggers: components.V3ExtensionsMSTeamsTriggers{
            AllActive: false,
            Custom: []components.V3ExtensionsMSTeamsEventClass{},
        },
        TenantID: "<id>",
        FromID: "<id>",
        ConnectedTeams: []components.V3ExtensionsMSTeamsConnectedTeams{
            components.V3ExtensionsMSTeamsConnectedTeams{
                TeamID: "<id>",
                TeamName: "<value>",
                ChannelConfigurations: []components.V3ExtensionsMSTeamsChannelConfiguration{
                    components.V3ExtensionsMSTeamsChannelConfiguration{
                        SquadcastTeamID: "<id>",
                        SquadcastTeamName: "<value>",
                        IsAllServices: true,
                        Services: []components.V3ExtensionsMSTeamsSquadCastServiceMapping{
                            components.V3ExtensionsMSTeamsSquadCastServiceMapping{
                                SquadcastServiceID: "<id>",
                                SquadcastServiceName: "<value>",
                            },
                        },
                        MsteamsChannelID: "<id>",
                        MsteamsChannelName: "<value>",
                    },
                },
            },
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "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"
          }
        ]
      }
    ]
  }
}