Snippets are a predefined set of tasks that can be quickly added to your runbooks. They make it easy to respond to unexpected issues by inserting ready-made task groups exactly when you need them. Snippets can also be used to extend or enhance your original plan, allowing you to add additional steps without rebuilding tasks from scratch.
This article explains what Snippets are, how to create and use them, and how the Snippet task type works.
Overview
The snippets you create — and how you use them — depend on your specific needs and the goals of your runbooks. This flexibility allows you to tailor snippets for a wide range of scenarios and continuously improve your plans so they run smoothly.
You can think of snippets as a library of short processes or actions that can be added to a runbook whenever an unexpected situation arises. For example, if a test fails during execution, a snippet can be quickly inserted to deploy and run a predefined fix, helping you resolve the issue without disrupting the rest of the runbook.
You should use snippets when you need flexibility and speed without changing the structure of your entire runbook. Snippets are especially useful when:
You need to respond to an unexpected issue during planning or execution (for example, adding recovery steps after a failed task).
You want to reuse a small set of tasks across multiple runbooks without creating a full template.
Certain steps are optional or conditional, and only needed in specific scenarios.
You want to apply a known fix or workaround quickly without stopping or redesigning the runbook.
You’re building a library of common actions (checks, rollbacks, validations) that can be added on demand.
In short, use templates to define your main plan upfront, and snippets when you need to adapt that plan in real time or extend it with targeted actions.
Create a Snippet
Snippets are created at the workspace level.
Things to note:
Snippets can be created and maintained by users with workspace runbook creator permissions.
Snippets can be added to paused non-dynamic or in progress dynamic runbooks.
Important: Only approved snippets (with at least one task) can be added to runbooks by Runbook Admins.
To create a snippet you will need to do the following:
In your workspace, open the Snippets tab.
Click + Create Snippet in the top-right corner.
3. The Create Snippet window opens.
4. Enter a clear, descriptive title and choose the folder where the snippet will be stored. Using folders helps keep reusable content organized.
5. Select any custom fields or custom field groups you want to include. If you need new custom fields, create them before creating the snippet.
Note: For help with creating custom fields or custom field groups, see this article.
6. Click + Create Snippet.
Once created, you can add your tasks. Adding and editing tasks follows the same process as creating tasks in a runbook. For help with creating tasks, see this article.
Snippet approval
New snippets are created in a Draft state, indicated by a grey Draft pill next to the snippet name. While in draft, the snippet can be edited freely.
To approve a snippet:
A user with the Runbook Admin role clicks Mark as approved in the banner at the bottom of the screen.
Note: Snippets in Draft or Rejected states cannot be used in runbooks.
2. A confirmation window appears.
Once approved, a green success message displays and an Approved pill appears next to the snippet name, along with its version number.
Once approved:
Runbook Admins can add the snippet to any number of runbooks.
Anyone with workspace access can use all available workspace snippets.
Task assignments are copied when a snippet is imported if the task is assigned to a team, or if it’s assigned to an individual who has a team member role on the snippet. Snippet Admins and Snippet Stream Editors are not imported.
Note: Approval flows can also be assigned to the Snippet runbook type. For more information on how approval works for runbook types with an assigned approval flow, see this article.
Make changes to a Snippet
To edit an approved snippet, you must first return it to Draft:
Revert the snippet to draft status.
2. The version number updates and the status pill changes to grey.
3. Make your changes.
4. Use the cog icon next to the snippet name to create a new version.
5. Once ready, approve the snippet again.
You can continue creating new versions as needed.
Snippet details menu
To view snippet details:
Click the pencil icon in the snippet list to open the right-hand edit panel.
While in Draft, you can edit/view:
Title and description
Folder and roles
Custom fields and field groups
Approval settings (view only)
Display settings
You can view the Approval settings and Display settings.
Display settings include:
Show team/user names in list – Displays full names instead of avatars.
Substreams inherit parent color – Applies the parent stream color to substream tasks.
The Runbook Type is displayed but cannot be edited.
The Other Details section shows who created the snippet.
More actions when viewing a Snippet
When viewing a snippet, additional actions are available from the cog icon at the top of the page.
The options you see will vary depending on whether the snippet is in a Draft or Approved state. Available actions may include:
Duplicate snippet – Create a copy of the snippet to reuse or modify.
Import tasks from CSV – Add tasks to the snippet by uploading a CSV file.
Create new version (draft only) – Create a new version of the snippet.
View version history – Review previous versions and changes.
Snippet user list (draft only) – See which users are associated with the snippet.
Save as saved view – Save your current view for quick access later.
Reload – Refresh the snippet view.
Archive – Archive the snippet when it’s no longer needed.
Filter Snippets
Whilst viewing your list of snippets you can use the Filter runbooks icon to make it easier to find particular snippets. This icon can be found on the top left of your list of snippets.
Here you have the option to search by:
Folder
Central Team
Snippet Status
Approval Status
Reviewer
Other (Snippets you can edit or are involved in.
To clear your filters, use the clear all option at the top of the grey filter panel.
Create a Snippet from multiple selected tasks
Workspace Runbook Creators can create a snippet from tasks in an existing runbook. This means that multiple tasks can be selected at any time and added as a snippet.
To create a snippet from multiple selected tasks, navigate to the runbook of your choice and follow the steps below:
Open a runbook and select the tasks required for your snippet.
Click the Create snippet icon.
Enter a title for the snippet and click Next.
Confirm creation.
A success message confirms the snippet has been created.
Things to note
Not available to folder runbook creators.
Tasks may be copied in separate sequences if there is no predecessor-successor relationship between them.
Users, teams, task assignments, and comms recipients are not copied.
Use a Snippet task type
If you are a Runbook Admin and your runbook is dynamic, you can prompt a task executor to add a snippet at a certain point during a run.
Create or edit a task.
Set the Task Type to Snippet.
Search for and select one or more approved snippets.
4. Click Save.
When the task starts, the executor selects a snippet to add or skips the task with a reason.
The task will show as a skipped task in the runbook list. The executor can then move onto the remaining tasks in the runbooks.
Import Snippets into a runbook
To add a snippet directly:
In a runbook, click More options where the snippet should follow.
2. Select Add snippet.
3. Choose a snippet.
Add a Snippet in sequence or in parallel
You can choose whether the snippet will be added in sequence or in parallel to the other tasks in the runbook. Any teams, tasks or streams defined within the snippet will also be added to the runbook.
In sequence: Snippet tasks are inserted between the task and its successor.
In the below example, task #4 from snippet 1 is added in sequence after task #1.
In parallel: Snippet tasks run alongside the successor task.
In the below example, tasks #5-10 from snippet two are added in parallel after task #2 — notice tasks #5-10 are "next to" task #3.
Click + Add to confirm.
Note: Sequential snippets inherit the dependencies of the original task.