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

Incidents/Communication Card

Create Slack Channel in Communication Card

post
/v3/extensions/slack_v2/channel
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

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

channel_namestringRequired
incident_idstringRequired
Responses
200

The request has succeeded.

application/json
post/v3/extensions/slack_v2/channel
POST /v3/extensions/slack_v2/channel HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "channel_name": "text",
  "incident_id": "text"
}
{
  "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
/v3/extensions/slack_v2/channel/archive
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Request body for archiving a Slack channel.

slack_channel_idstringRequired
Responses
200

The request has succeeded.

application/json
post/v3/extensions/slack_v2/channel/archive
POST /v3/extensions/slack_v2/channel/archive HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "slack_channel_id": "text"
}
{
  "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
/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
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
IncidentIdstringRequired
Responses
200

The request has succeeded.

application/json
get/v3/incidents/{IncidentId}/communication_cards
GET /v3/incidents/{IncidentId}/communication_cards HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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
/v3/incidents/{IncidentId}/communication_cards
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
IncidentIdstringRequired

Required

Body

Request body for creating a communication card.

typestringRequired
urlstringRequired
titlestringRequired
Responses
200

The request has succeeded.

application/json
post/v3/incidents/{IncidentId}/communication_cards
POST /v3/incidents/{IncidentId}/communication_cards HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "type": "text",
  "url": "text",
  "title": "text"
}
{
  "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
/v3/incidents/{IncidentId}/communication_cards/{communicationCardId}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
IncidentIdstringRequired

Required

communicationCardIdstringRequired
Body

Request body for updating a communication card.

titlestringRequired
typestringRequired
urlstringRequired
Responses
200

The request has succeeded.

application/json
put/v3/incidents/{IncidentId}/communication_cards/{communicationCardId}
PUT /v3/incidents/{IncidentId}/communication_cards/{communicationCardId} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "title": "text",
  "type": "text",
  "url": "text"
}
{
  "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
/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
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
delete/v3/incidents/{IncidentId}/communication_cards/{communicationCardId}
DELETE /v3/incidents/{IncidentId}/communication_cards/{communicationCardId} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Accept: */*

{
  "data": "text"
}
PreviousIncidents/Notes
NextIncidents/Tags

Last updated