Skip to content

Customer onboarding

Takes a signed customer from kickoff to go-live with customer success, solutions, agents and the customer’s own setup.

Source: scripts/dev/review-runbooks/customer-onboarding.yaml. CI checks it with runbook spec validate; teams, people, skills and called runbooks it names resolve against your server when you publish it.

apiVersion: therunbook.app/v1
kind: Runbook
metadata:
id: customer-onboarding
title: Customer onboarding
description: Takes a signed customer from kickoff to go-live with customer success, solutions, agents and the customer's own setup.
owners: [team:customer-success]
tags: [customers, onboarding]
spec:
execution:
title: "Onboard ${{ inputs.customer }}"
inputs:
customer: { type: string, required: true }
plan: { type: enum, options: [starter, growth, enterprise], required: true }
region: { type: enum, options: [us, eu], default: us }
defaults: { actor: agent }
steps:
- id: kickoff
title: Kickoff call with the customer
actor: human
assignee: team:customer-success
instructions: Run the kickoff call. Agree goals, name the customer's technical contact and propose a go-live date.
checklist: [Goals and success criteria agreed, Technical contact named, Go-live date proposed]
- id: provision
title: Provision the workspace
instructions: |
Create the workspace for ${{ inputs.customer }} in the ${{ inputs.region }} region on the
${{ inputs.plan }} plan, invite the technical contact as an admin, and record the workspace ID.
outputs:
workspace_id: { type: string, required: true }
- id: setup
title: Set up the account
parallel:
- id: sso
title: Configure SSO with the customer's identity provider
actor: human
assignee: team:solutions
instructions: Exchange SAML metadata with the customer's IT team and test a sign-in with their test user.
checklist: [SAML metadata exchanged, Test sign-in works, Just-in-time provisioning on]
- id: import_history
title: Import historical data
instructions: Import the customer's last 12 months of orders from the export they shared. Report the row count.
outputs:
rows_imported: { type: integer, required: true }
- id: billing
title: Set up billing and invoicing
actor: human
assignee: user:Priya Natarajan
instructions: Create the subscription for the ${{ inputs.plan }} plan and send the first invoice.
checklist: [Subscription created, Invoice contact confirmed]
- id: customer_connects
title: Customer connects their store
wait: { signal: store_connected, timeout: 7d }
- id: first_events
title: First events received
check: true
instructions: Reported by the ingestion API once the customer's first live events arrive.
outputs:
events: { type: integer, required: true }
- id: go_live
title: Approve go-live
approval:
prompt: Everything is set up for ${{ inputs.customer }}. Switch them to live?
options: [go_live, hold]
approvers: { teams: [customer-success] }
timeout: 3d
- id: welcome
title: Send the welcome pack
if: "${{ steps.go_live.outputs.decision == 'go_live' }}"
instructions: Email the welcome pack and the first-week checklist to the customer's admins.

Publish it to a project:

Terminal window
runbook push customer-onboarding.yaml --project <project> --draft
runbook publish customer-onboarding --project <project>