Deployment PlaybookDocsSign inGet started

Getting started

Deployment Playbook turns your release checklist into a plan with phases (Before, During, After deployment), approvals and an audit trail, and lets your CI/CD pipeline wait on it through a simple gate API.

1. Create a workspace

  1. Sign up with email + password (or Google, GitHub or Microsoft when enabled). With email + password, open the verification link we email you first.
  2. Name your organisation. You become the workspace Admin with every role, and a default template Standard deployment is created for you.
  3. Invite your team from Members & roles. A person can hold several roles (see Concepts).

2. Look at the template

Open Templates → Standard deployment. Each step belongs to a phase, is required or optional, and can need four-eyes (two different approvers). Edit the steps and save to create a new template version. Plans always keep a snapshot of the version they were created from.

Copy the Template ID at the top of the page: you use it from CI (POST /api/plans) and from the MCP server.

3. Create a plan

Either click New plan in the app, or let CI create it from a git tag (recommended, see Create a plan on a git tag). A new plan is Proposed and must be approved by an Approver (two with plan-wide four-eyes) before any step can be worked on.

4. Gate your pipeline

  1. As Admin, create an API token on Connections & webhooks. It is shown once; store it as a CI secret.
  2. Let each pipeline stage poll the gate until it returns allow: true:
curl -fsS -H "Authorization: Bearer $PLAYBOOK_API_TOKEN" \
  "https://deployment-playbook.com/api/gate/$PLAN_ID?phase=during" | jq -e '.allow'
  1. Approve steps in the app and watch the pipeline continue.

A complete, copy-paste GitHub Actions example lives in the public repository Generation-Y-BV/deployment-playbook-example.

Next

Concepts →