Incidents/Communication Card

Create Slack Channel in Communication Card

post

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

/v3/extensions/slack_v2/channel

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Request body for creating a Slack channel in a communication card.

channel_namestringRequired

incident_idstringRequired

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/slack_v2/channel

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.CommunicationCards.CreateSlackChannel(ctx, components.V3IncidentsCommunicationCardsCreateSlackChannelRequest{
        ChannelName: "<value>",
        IncidentID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "created_at": "text",
    "updated_at": "text",
    "deleted_at": null,
    "id": 1,
    "incident_id": "text",
    "url": "text",
    "type": "text",
    "title": "text",
    "channel_id": "text",
    "archived_at": null
  }
}

Archive Slack Channel

post

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

/v3/extensions/slack_v2/channel/archive

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Request body for archiving a Slack channel.

slack_channel_idstringRequired

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/slack_v2/channel/archive

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.CommunicationCards.ArchiveSlackChannel(ctx, components.V3IncidentsCommunicationCardsArchiveSlackChannelRequest{
        SlackChannelID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "created_at": "text",
    "updated_at": "text",
    "deleted_at": null,
    "id": 1,
    "incident_id": "text",
    "url": "text",
    "type": "text",
    "title": "text",
    "channel_id": "text",
    "archived_at": null
  }
}

Get All Communication Card

get

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

/v3/incidents/{IncidentId}/communication_cards

• This endpoint is used to get all the communication card details for incidentId metioned in params.

• Requires access_token as a Bearer {{token}} in the Authorization header.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IncidentIdstringRequired

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/incidents/{IncidentId}/communication_cards

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.Incidents.CommunicationCards.GetAll(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": [
    {
      "created_at": "text",
      "updated_at": "text",
      "deleted_at": null,
      "id": 1,
      "incident_id": "text",
      "url": "text",
      "type": "text",
      "title": "text",
      "channel_id": "text",
      "archived_at": null
    }
  ]
}

Create Communication Card

post

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

/v3/incidents/{IncidentId}/communication_cards

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IncidentIdstringRequired

Required

Body

application/json

Request body for creating a communication card.

typestringRequired

urlstringRequired

titlestringRequired

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/incidents/{IncidentId}/communication_cards

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.Incidents.CommunicationCards.Create(ctx, "<id>", components.V3IncidentsCommunicationCardsCreateCommunicationCardRequest{
        Type: "<value>",
        URL: "https://oily-injunction.info",
        Title: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "created_at": "text",
    "updated_at": "text",
    "deleted_at": null,
    "id": 1,
    "incident_id": "text",
    "url": "text",
    "type": "text",
    "title": "text",
    "channel_id": "text",
    "archived_at": null
  }
}

Update Communication Card

put

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

/v3/incidents/{IncidentId}/communication_cards/{communicationCardId}

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IncidentIdstringRequired

Required

communicationCardIdstringRequired

Body

application/json

Request body for updating a communication card.

titlestringRequired

typestringRequired

urlstringRequired

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

put

/v3/incidents/{IncidentId}/communication_cards/{communicationCardId}

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.Incidents.CommunicationCard.Update(ctx, "<id>", "<id>", components.V3IncidentsCommunicationCardsUpdateCommunicationCardRequest{
        Title: "<value>",
        Type: "<value>",
        URL: "https://major-cantaloupe.com/",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "created_at": "text",
    "updated_at": "text",
    "deleted_at": null,
    "id": 1,
    "incident_id": "text",
    "url": "text",
    "type": "text",
    "title": "text",
    "channel_id": "text",
    "archived_at": null
  }
}

Delete Communication Card

delete

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

/v3/incidents/{IncidentId}/communication_cards/{communicationCardId}

Delete communication card by providing communicationCardId for incidentId mentioned in params

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IncidentIdstringRequired

Required

communicationCardIdstringRequired

Header parameters

authorizationstringRequired

Responses

200

The request has succeeded.

application/json

datastringRequired

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

delete

/v3/incidents/{IncidentId}/communication_cards/{communicationCardId}

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.Incidents.CommunicationCards.Delete(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": "text"
}