What are Snippets?
Snippets are instruction fragments you can include in any runbook. They’re perfect for procedures that appear in multiple contexts:| Snippet | Used In |
|---|---|
| ”Verify Customer Identity” | Password Reset, Account Recovery, Billing Dispute, Order Cancellation |
| ”Check Subscription Status” | Billing Questions, Feature Access, Upgrade Requests |
| ”Standard Closing” | All customer-facing runbooks |
Why Use Snippets?
Consistency
The same procedure is executed the same way everywhere.Efficiency
Write once, use in many runbooks.Maintenance
Update in one place, changes apply everywhere.Organization
Keep runbooks focused on their specific purpose.Creating Snippets
1
Navigate to Snippets
Go to Build → Snippets in your dashboard.
2
Click Create Snippet
Click Create Snippet to open the editor.
3
Name Your Snippet
Use a clear, action-oriented name:
- Good: “Verify Customer Identity”, “Process Refund”
- Avoid: “Snippet 1”, “Identity”
4
Write Instructions
Write the reusable instructions. These can include:
- Steps
- Conditional logic
- Tool references
5
Save
Click Save to save your snippet.
Example Snippets
Verify Customer Identity
Check Subscription Status
Standard Closing
Using Snippets in Runbooks
Insert snippets in your runbook using the snippet reference syntax:Managing Snippets
Viewing Usage
Each snippet shows which runbooks use it:Editing Snippets
When you edit a snippet:- Changes save immediately
- All runbooks using the snippet get the update
- No need to update individual runbooks
Deleting Snippets
Before deleting:- Check which runbooks use the snippet
- Remove or replace the snippet references
- Then delete the snippet
Best Practices
When to Create a Snippet
Create a snippet when:- The same instructions appear in 2+ runbooks
- The procedure needs to be consistent everywhere
- You want to update the procedure in one place
Snippet Scope
Keep snippets focused:- Good: “Verify Customer Identity” — one clear purpose
- Avoid: “Handle Customer” — too broad
Naming
Use action-oriented names that describe what the snippet does:- “Verify Customer Identity”
- “Check Order Status”
- “Process Refund Request”
- “Standard Closing”
Documentation
Add comments in your snippet explaining:- When to use it
- What it accomplishes
- Any prerequisites