Skip to main content
Automagically is currently in a closed beta.

Building a Runbook

A runbook is a reusable automation that resolves a specific IT request. You describe the task in plain English, and Automagically plans it, builds it, tests it, and hands it back to you for approval, ready to run against your clients’ environments.

Start a new runbook

You can start building a runbook in two ways:
  • From the Automagically portal: click New Runbook.
    Runbooks page header with the New Runbook button next to Review approvals
    New Automation chat with suggested prompts and a message box for describing the runbook
  • From Super Magic chat: ask Automagically to build a runbook for the task you have in mind.

Describe the task

Tell Automagically what you want automated, in plain English, the same way you’d explain it to a colleague.
Be specific about how forms and outputs should look. For example: “Present the user selection as a drop-down and allow multiple selections.”
Chat message asking for a runbook that hides users from the Global Address List using a multiselect drop-down

How Automagically builds your runbook

Building happens in two phases.
  1. Planning: Automagically drafts a plan and presents it for your approval. This is your chance to shape the runbook, ask it to add or remove steps, change input fields, or adjust anything else before building starts.
    Plan review for Mailbox - Hide Users from Address List with the plan overview and Approve and Request changes
    Plan review table listing the runbook's input parameters and steps, with Approve and Request changes buttons
  2. Building: once you approve the plan, Automagically builds the runbook, runs quality checks, and automatically fixes any issues it finds.
    Build log showing Pester tests failing, being fixed automatically, then passing a guardrail check
As part of the build, Automagically opens a testing window so you can try the runbook before it goes live.
Testing step with a Test your newly created runbook form, Submit button, and Skip test and Request changes

Approve the runbook

Before a runbook can run in a client environment, it must be reviewed and approved in the Approvals tab. Approval includes a code review and requires a successful staging test.
See Automagically: Approving Runbooks for details.
Chat message confirming the runbook was built as version 1 and needs approval in the Approvals tab
Review changes panel showing the runbook code with Test in staging, Reject all changes and Approve all changes
Staging test form for the Hide Users from Address List runbook with its summary and Test in staging button

Run it

Once approved, the runbook appears under the Active tab in Runbooks and is ready to resolve support requests. See Automagically: Running Runbooks for the ways runbooks can be triggered.
Runbooks Active tab showing the approved runbook card with Test and Run buttons
Runbook details page with AI summary, steps and the Run button for the approved version 1