Runbooks
Returns all the runbooks of the team. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.
The request has succeeded.
The server could not understand the request due to invalid syntax.
Access is unauthorized.
Client error
Access is forbidden.
The server cannot find the requested resource.
The request conflicts with the current state of the server.
Client error
Server error
Server error
Service unavailable.
Server error
GET /v3/runbooks HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": [
{
"id": "text",
"name": "text",
"created": {
"user_name": "text",
"username_for_display": "text",
"user_id": "text",
"at": "2026-01-01T00:00:00.000Z",
"entity_owner": {
"id": "text",
"type": "text"
}
},
"updated": {
"user_name": "text",
"username_for_display": "text",
"user_id": "text",
"at": "2026-01-01T00:00:00.000Z",
"entity_owner": {
"id": "text",
"type": "text"
}
},
"used_count": 1,
"steps": [
{
"content": "text"
}
],
"entity_owner": {
"id": "text",
"type": "text"
},
"organization_id": "text",
"owner": {
"id": "text",
"type": "team"
}
}
]
}Add runbook to the team. Returns the runbook object in response. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.
Represents the request body for creating a new runbook.
The name of the runbook.
The ID of the team that owns this runbook.
The request has succeeded and a new resource has been created as a result.
The server could not understand the request due to invalid syntax.
Access is unauthorized.
Client error
Access is forbidden.
The server cannot find the requested resource.
The request conflicts with the current state of the server.
Client error
Server error
Server error
Service unavailable.
Server error
POST /v3/runbooks HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105
{
"name": "text",
"steps": [
{
"content": "text"
}
],
"owner_id": "text",
"entity_owner": {
"id": "text",
"type": "text"
}
}{
"data": {
"id": "text",
"name": "text",
"created": {
"user_name": "text",
"username_for_display": "text",
"user_id": "text",
"at": "2026-01-01T00:00:00.000Z",
"entity_owner": {
"id": "text",
"type": "text"
}
},
"updated": {
"user_name": "text",
"username_for_display": "text",
"user_id": "text",
"at": "2026-01-01T00:00:00.000Z",
"entity_owner": {
"id": "text",
"type": "text"
}
},
"used_count": 1,
"steps": [
{
"content": "text"
}
],
"entity_owner": {
"id": "text",
"type": "text"
},
"organization_id": "text",
"owner": {
"id": "text",
"type": "team"
}
}
}Returns a runbook details of the given runbookID in the request param. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.
The request has succeeded.
The server could not understand the request due to invalid syntax.
Access is unauthorized.
Client error
Access is forbidden.
The server cannot find the requested resource.
The request conflicts with the current state of the server.
Client error
Server error
Server error
Service unavailable.
Server error
GET /v3/runbooks/{runbookID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": {
"id": "text",
"name": "text",
"created": {
"user_name": "text",
"username_for_display": "text",
"user_id": "text",
"at": "2026-01-01T00:00:00.000Z",
"entity_owner": {
"id": "text",
"type": "text"
}
},
"updated": {
"user_name": "text",
"username_for_display": "text",
"user_id": "text",
"at": "2026-01-01T00:00:00.000Z",
"entity_owner": {
"id": "text",
"type": "text"
}
},
"used_count": 1,
"steps": [
{
"content": "text"
}
],
"entity_owner": {
"id": "text",
"type": "text"
},
"organization_id": "text",
"owner": {
"id": "text",
"type": "team"
}
}
}Update runbook details. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.
Represents the request body for updating a runbook.
The name of the runbook.
The request has succeeded.
The server could not understand the request due to invalid syntax.
Access is unauthorized.
Client error
Access is forbidden.
The server cannot find the requested resource.
The request conflicts with the current state of the server.
Client error
Server error
Server error
Service unavailable.
Server error
PUT /v3/runbooks/{runbookID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87
{
"name": "text",
"steps": [
{
"content": "text"
}
],
"entity_owner": {
"id": "text",
"type": "text"
}
}{
"data": {
"id": "text",
"name": "text",
"created": {
"user_name": "text",
"username_for_display": "text",
"user_id": "text",
"at": "2026-01-01T00:00:00.000Z",
"entity_owner": {
"id": "text",
"type": "text"
}
},
"updated": {
"user_name": "text",
"username_for_display": "text",
"user_id": "text",
"at": "2026-01-01T00:00:00.000Z",
"entity_owner": {
"id": "text",
"type": "text"
}
},
"used_count": 1,
"steps": [
{
"content": "text"
}
],
"entity_owner": {
"id": "text",
"type": "text"
},
"organization_id": "text",
"owner": {
"id": "text",
"type": "team"
}
}
}Remove runbook from team. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.
There is no content to send for this request, but the headers may be useful.
The server could not understand the request due to invalid syntax.
Access is unauthorized.
Client error
Access is forbidden.
The server cannot find the requested resource.
The request conflicts with the current state of the server.
Client error
Server error
Server error
Service unavailable.
Server error
DELETE /v3/runbooks/{runbookID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{}Last updated