Incidents/Notes

Get All Notes

get

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

/v3/incidents/{IncidentId}/warroom

• This endpoint is used to get all the note details of incidentID mentioned 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}/warroom

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

{
  "data": [
    {
      "id": "text",
      "created_at": "text",
      "updated_at": "text",
      "organization_id": "text",
      "incident_id": "text",
      "user_id": "text",
      "message": "text",
      "type": "text",
      "attachments": [
        "text"
      ],
      "user": {
        "id": "text",
        "first_name": "text",
        "last_name": "text",
        "deleted": true
      },
      "replaced_message": "text"
    }
  ]
}

Create Notes

post

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

/v3/incidents/{IncidentId}/warroom

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IncidentIdstringRequired

Required

Body

application/json

Request body for creating a new note.

messagestringRequired

attachmentsstring[]Required

Responses

201

The request has succeeded and a new resource has been created as a result.

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}/warroom

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.Notes.Create(ctx, "<id>", components.V3IncidentsNotesCreateNoteRequest{
        Message: "<value>",
        Attachments: []string{
            "<value 1>",
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "body": {
    "data": {
      "id": "text",
      "created_at": "text",
      "updated_at": "text",
      "organization_id": "text",
      "incident_id": "text",
      "user_id": "text",
      "message": "text",
      "type": "text",
      "attachments": [
        "text"
      ],
      "user": {
        "id": "text",
        "first_name": "text",
        "last_name": "text",
        "deleted": true
      },
      "replaced_message": "text"
    }
  }
}

Update Note

put

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

/v3/incidents/{IncidentId}/warroom/{NoteId}

This API can be used to update a Note or a Resolution reason associated with an incident

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

IncidentIdstringRequired

Required

NoteIdstringRequired

Body

application/json

Request body for updating an existing note.

messagestringRequired

attachmentsstring[]Required

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}/warroom/{NoteId}

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.Notes.Update(ctx, "<id>", "<id>", components.V3IncidentsNotesUpdateNoteRequest{
        Message: "<value>",
        Attachments: []string{},
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "created_at": "text",
    "updated_at": "text",
    "organization_id": "text",
    "incident_id": "text",
    "user_id": "text",
    "message": "text",
    "type": "text",
    "attachments": [
      "text"
    ],
    "user": {
      "id": "text",
      "first_name": "text",
      "last_name": "text",
      "deleted": true
    },
    "replaced_message": "text"
  }
}

Delete Note

delete

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

/v3/incidents/{IncidentId}/warroom/{NoteId}

delete note from 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

NoteIdstringRequired

Required

Header parameters

authorizationstringRequired

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

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}/warroom/{NoteId}

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

{}