Prerequisites
- A valid API key with playbook read/write permissions
- At least one incident ticket to test against (see Manage Incidents)
Create a playbook
Build a playbook by posting its steps and metadata. Steps can include instructions, commands, verification checks, or escalation actions.id you will use in subsequent calls.
List and retrieve playbooks
Update a playbook
Iterate on a playbook’s steps or metadata before publishing. Updates to a draft do not affect in-progress executions.Publish a playbook
A playbook must be published before it can be matched to incidents or executed. Publishing freezes the current version.To revise a published playbook, update it (which creates a new draft) and publish again. Existing executions continue against the version they were started on.
Match a playbook to an incident
Scrubbe can suggest which published playbooks are most relevant for a given incident. Use this when you are unsure which runbook to follow.Execute a playbook
Start an execution of a published playbook against a specific incident. An execution tracks which steps have been completed, skipped, or are pending.executionId you will use to manage step progress.
Manage execution steps
Work through the playbook step by step. Step indexes are zero-based.1
Complete a step
Mark a step done once the action is taken and verified.
2
Skip a step
Skip a step when it is not applicable to this specific incident.
3
Complete the execution
Once all steps are done, close the execution.