Skip to content

Playbooks

Playbooks are multi-step automation workflows. Each step performs one action — call an AI model, fetch data, transform a result, write to a knowledge base — and passes its output to the next step.

When to use a playbook

Use a playbook when you need to chain two or more actions together, run something on a schedule, or let a chat widget trigger a workflow automatically.

Good fitNot a good fit
Weekly report generationSingle one-off AI prompt
Fetching external data + summarisingInteractive back-and-forth conversation
Form submission → Odoo CRM entrySimple content generation (use Content instead)
Scheduled Odoo data pullTasks already covered by Routers alone

Trigger types

TriggerDescription
ManualRun from the Studio UI or CLI on demand
ScheduleCron expression — hourly, daily, weekly
EventRouter sends an incoming event to the playbook
AgentA chat widget's AI triggers the playbook by tool call

Anatomy of a playbook

Playbook
├── name: "Weekly Report"
├── trigger_type: schedule
├── output_key: report          ← which step's output is the final result
└── steps:
    ├── Step 1 (odoo_read)      → output_key: raw_data
    ├── Step 2 (ai_prompt)      → output_key: summary   ← uses {{.step_outputs.raw_data}}
    └── Step 3 (export_output)  → output_key: report

Each step declares an output_key. Later steps reference earlier outputs using {{.step_outputs.<key>}}.

Getting started

Managing playbooks as code

Playbooks can be version-controlled as YAML and deployed via the provision tool or taufinity CLI. See Provision & CLI.