LogoLogo
API DocsDeveloper PortalSystem StatusTry for Free
  • Quickstart Guide
    • Introduction
    • Get started as an Account Owner
    • Get started as a User
    • Glossary
    • FAQs
  • Manage Users
    • Types of Users
    • Add and Delete Users
    • Import Users
    • User Permissions - Access Controls
    • Manage Your Profile
    • Notification Rules
    • On-Call Reminder Rules
    • Change Account Owner
  • Manage Teams
    • Understanding Teams
    • Role Based Access Control
    • Owner Based Access Control
    • Create and Delete Teams
    • Add and Remove Team Members
    • Squads
    • Stakeholder Groups
  • Services
    • Adding a Service
    • Service Overview
    • Service Graph
    • Maintenance Mode
    • Alert Deduplication Rules
      • Alert Deduplication Rules
      • Incident Status Based Deduplication
      • Service Dependency Based Deduplication
      • Key Based Deduplication
    • Event Tagging
    • Alert Routing
    • Alert Suppression
    • Custom Content Templates
    • Intelligent Alert Grouping (IAG)
    • Auto Pause Transient Alerts (APTA)
    • Delayed Notifications
  • Schedules
    • Schedules (New)
      • Adding a Schedule
      • Schedules Overview
      • Who is On-Call?
      • My On-Call Shifts
      • Overrides
      • Videos: How to set up common use cases?
  • Escalation Policies
    • Create and Manage Escalation Policy
    • Round Robin & Advanced Escalations
    • Reassign an Incident
  • Notifications
    • Understanding Incident Notifications
  • Dashboards
    • Incident Management Dashboard
    • Dashboard Metrics
    • Take Bulk Actions
    • Squadcast Search
  • Incident List
    • Incident List View
    • Incident Priorities
    • Filter Incidents
    • Save Filter View
    • Merge Incidents
    • Snooze Incidents
  • Incidents Page
    • Incidents Details
    • Incident Activity Timeline
    • Communication Channels
    • Create Incident Manually
    • Incident Notes
    • Incident Watchers
    • Past Incidents
    • Additional Responders
    • Incident Summaries
    • Incident Suggestions
  • Runbooks
    • Runbooks
  • Postmortems
    • Postmortem Templates
    • Create Postmortems
    • Accessing Postmortem
  • Status Page
    • Status Page
    • Status Page Overview
    • Components and Groups
    • Issues
    • Subscribers
    • Maintenance
  • SLO Tracker
    • SLO Basics
    • Configure and Monitor your SLOs
  • Webforms
    • Webforms
  • Global Event Rulesets
    • Global Event Rulesets
  • Workflows
    • Workflows
    • Workflows Overview
    • Actions
  • Live Call Routing
    • Live Call Routing
  • Analytics
    • Analytics (New)
    • Organization Level Analytics
    • On Call Hours Per User
    • Weekly Reports
  • Integrations
    • Incident Webhook (Incident Webhook/API)
    • Outgoing Webhooks
    • ServiceNow Extension
    • Extensions
      • Jira Cloud Integration
      • Jira DC (Data Center)
      • CircleCI
      • Google Chat
      • Freshdesk
      • Freshservice
      • Asana
      • ClickUp
      • Trello
      • Zendesk
      • Hubspot
    • Alert Source Integrations (Native)
      • Admin Labs
      • Airbrake
      • Amazon EventBridge
      • Amazon GuardDuty
      • Amazon Opensearch
      • APImetrics
      • AppDynamics
      • AppSignal
      • Auvik
      • AWS CloudTrail Logs
      • AWS CloudTrail via CloudWatch
      • Amazon Cloudwatch (AWS) Integration
      • AWS CloudWatch Event Rules
      • AWS Elastic Beanstalk via CloudWatch
      • Amazon RDS (AWS)
      • Amazon SNS (AWS)
      • Azure Monitor
      • Better Uptime
      • Bitbucket
      • Bitrix 24
      • Blue Matador
      • Bugsnag
      • Buildkite
      • Checkly
      • Checkmk
      • CircleCI Integration
      • Cisco DNAC
      • Cisco Meraki
      • ClickUp Integration
      • CloudAMQP
      • Cloudflare
      • Conviva
      • CopperEgg
      • Coralogix
      • Cronitor
      • Crowdstrike Falcon
      • Datadog
      • Databricks
      • Dead Man's Snitch
      • Domotz
      • Dotcom Monitor
      • Dynatrace
      • ElastAlert
      • Elastic
      • Elecard Boro
      • Email Integration
      • Endtest
      • Errorception
      • Freshdesk Integration
      • Freshping
      • Freshservice
      • Ghost Inspector
      • GitHub Integration
      • GitLab
      • Grafana 8
      • Grafana
      • Graylog v4
      • Graylog
      • HaloPSA
      • Healthchecks
      • Heroku
      • HetrixTools
      • Honeybadger
      • Honeycomb
      • Humio
      • Hund
      • Hydrozen
      • Hyperping
      • Icinga2
      • InsightOps (LogEntries)
      • Instana
      • Intercom
      • Jenkins Integration
      • Jira Cloud Alert Source
      • Jira Server Alert Source
      • Kapacitor
      • Kentik
      • Komodor
      • Kibana
      • LibreNMS
      • Linear
      • Loggly
      • Logstash
      • Logz.io
      • ManageEngine Application Manager
      • ManageEngine Opmanager
      • Mezmo (formerly LogDNA)
      • MongoDB Atlas / Cloud Manager
      • Nagios
      • New Relic
      • Nixstats
      • NodePing
      • Observium
      • Oh Dear
      • Oracle Cloud Infrastructure
      • OSNexus QuantaStor
      • OverOps
      • Papertrail
      • Pingdom
      • Plesk 360
      • Postman
      • Postmark
      • Powercode
      • Progress WhatsUp Gold
      • Prometheus
      • PRTG Network Monitor
      • Rapid7 InsightIDR
      • RapidSpike
      • Redash
      • Redgate SQL Monitor
      • Rollbar
      • Rundeck
      • Runscope
      • Salesforce Cloud
      • Scout APM
      • Sematext
      • Sensu Go
      • Sensu
      • Sentry.io
      • Server Density
      • ServerGuard24
      • ServiceNow Integration
      • Shortcut (Clubhouse)
      • SignalFx
      • SigNoz
      • Site24x7
      • Slack
      • SolarWinds AppOptics
      • SolarWinds Observability SaaS (SWO)
      • SolarWinds Observability Self Hosted
      • Sonar
      • Splunk
      • Sqreen
      • Stackdriver
      • Stackify Retrace
      • StatHat
      • StatusCake
      • ServiceDesk Plus OD
      • Sumo Logic
      • Sysdig Monitor
      • Threat Stack
      • Trello
      • Twilio
      • Uptime
      • Uptime Robot
      • Uptrends
      • Wavefront
      • Zabbix 5.0
      • Zabbix 6.2
      • Zabbix
      • Zendesk Integration
      • Zoho Desk
      • Zoho Desk via Zoho Flow
      • LogicMonitor
  • ChatOps
    • Google Chat
    • Microsoft Teams
    • Slack for Incident Management
      • Using the Integration
  • Single Sign-On (SSO)
    • AWS SSO
    • Azure Active Directory SSO
    • Google SSO
    • Microsoft ADFS SSO
    • Okta SSO Integration
    • SAML 2.0 based SSO
  • Mobile App
    • Using the Mobile App
  • Terraform & API Documentation
    • Terraform Provider
    • Public API - Refresh Token
    • API Documentation
    • Getting Started with Squadcast GraphQL
      • Schedules
        • Create Schedule
        • Update Schedule
        • Delete Schedule
        • Pause Schedule
        • Get Schedules
        • Get Schedule by ID
        • Resume Schedule
        • Clone Schedule
        • Get Gaps
      • Rotations
        • Create Rotation
        • Update Rotation
        • Delete Rotation
        • Get Rotation by ID
        • Get Rotation Events by ID
      • Overrides
        • Create Override
        • Update Override
        • Delete Override
        • Get Override by ID
      • Calendar URLs
      • Who is On-Call
    • Developer Portal
    • Incident Rate Limiting
  • Managing your Squadcast Account
    • Audit Logs
    • Organizations
    • Billing FAQs
    • Deactivate your Squadcast Account
    • Delete your Squadcast Account
Powered by GitBook
On this page
  • Understanding Runbooks
  • Creating Runbooks
  • Attaching Runbooks to Incidents
  • Incident Tasks
  • Creating Tasks

Was this helpful?

  1. Runbooks

Runbooks

Create, attach, reference and mark progress for incident resolution using Runbooks

PreviousIncident SuggestionsNextPostmortem Templates

Last updated 4 months ago

Was this helpful?

Understanding Runbooks

A Runbook is a compilation of routine procedures and operations that are documented for reference while working on a critical incident. Sometimes, it can also be referred to as a Playbook.

Typically, organizations store their incident checklists in various places such as Google Docs, Notion, Confluence etc., and sometimes even stored in a physical notebook. Valuable time is lost in searching for these different checklists and following up on the list items while working on critical incidents.

In order to avoid delays, scrambling between multiple tools and tabs to find the right checklist, Squadcast brings to you Runbooks. This feature will help you access the relevant Runbook, associate it with incidents and assign tasks to relevant users.

Simple Runbooks are a checklist of tasks that need to be performed manually for an incident. These could either be procedures that need to be performed during the occurrence of a Sev1 incident, or technical/functional instructions to debug and fix a certain issue, along with the code that needs to be manually executed.

One can easily create Runbooks and use it as a reference once it is attached to an incident. Additionally, one can mark the progress against each step in the Runbook.

Note:

Creating Runbooks

RBAC Prerequisites

Runbooks are a Team-level entity and in order to create a Runbook, the user role should have the following Team-level Role permissions:

  • create permission to create Runbooks

  • read permission for viewing Runbooks

  • update permission for editing Runbooks

  • delete permission for deleting Runbooks

(1) To create a Runbook, the user needs to click on the Runbook menu on the left navigation bar and click on the Create Runbook button

(2) In the Create Runbook page:

  • Enter a Name for the Runbook

  • Start adding steps for the Runbook by clicking on the + Add Step button

You can add as many steps as you like. Every step supports Markdown, hence you can use Markdown formatting features like Code Blocks, Bold, Italic, Ordered & Unordered List, Images & Links. You can manually upload images and attachments as well.

Although you can add all the series of actions within a single step, we recommend you add each action as a separate step. It would be helpful to mark the progress of each step by checking it done.

You can switch between the Edit mode & View mode (Preview) by using the Visual/Markdown option. You can also drag & drop each step to rearrange their order.

After adding all the details, click on the Save button and the Runbook is created.

Once created, you can view, edit or delete an existing Runbook.

Note:

The Runbooks created here to act as a template and any update to the Runbook will only get applied to subsequent incidents and not to any previously attached incidents.

Attaching Runbooks to Incidents

(1) Open an incident and click on the Runbooks & Tasks tab and then click on the Attach Runbook option

(2) Select the Runbook(s) that you want to be attached to the incident and click on the final Attach Runbooks button

You have the option to attach more than one Runbook to an incident.

(3) The Runbook will be attached and listed. One can then follow the Runbook and perform the steps. They can also mark the completion of each step by checking the checkbox for each step

Note:

Every action on a Runbook, such as adding a Runbook, or completing a step - of it gets recorded in the Incident Timeline automatically.

Incident Tasks

Tasks are instructions or to-dos for other team members or even follow-up tasks for an incident. The ability to have tasks associated with an incident comes in handy for critical incidents where most often than not, there would be a list of tasks that need to be completed even post-incident closure, to ensure final fixes are in place.

Creating Tasks

(1) To create a task, click on the Add Task option under the Runbooks & Tasks tab

(2) Here, enter the details of the task. You can use Markdown formatting for it. Then, click on the final Add Task button to generate your task list

(3) Similar to Runbook actions, the completion of the task can also be marked using the checkbox

For any queries on Runbooks and Tasks, reach out to our Support Team and they will be happy to assist you.

Simple Runbooks will be available for accounts in the .

Have any questions? .

Premium and Enterprise plans
Ask the community
Squadcast dashboard - Create Runbook
Create Runbook in steps
Add steps in the Rubooks
Save created Runbook
Attaching Runbooks to Incidents
Select attached Runbook
Mark completion of steps in a Runbook
Create Tasks
Add Tasks - supports markdown
Mark completion of Tasks