Guides
Task-oriented guides built from runnable samples.
Every guide in this section is built from a runnable sample in the repository's
samples/ directory.
Each one walks through a working flow YAML, explains the pieces as it builds
them up, and gives you the exact commands to run and test it — most samples need
zero setup beyond the octo binary.
HTTP & APIs
Build a REST API
Serve HTTP endpoints with routing, path params, and response shaping.
Call External APIs
Use the HTTP client with auth, retries, and response caching.
Database CRUD
Query SQLite or Postgres with parameterized SQL.
Data
Transforming Data
Reshape payloads with multi-transform, enrich scopes, and CEL.
Validation and Auth
Validate input with CEL rules and protect endpoints with JWT.
Debugging a Flow
Stop at any block and inspect the message — or learn the block was never reached.
Testing a Flow
Write a flow's tests beside it, mock what calls the world, and run them in CI.
Composition & messaging
Composing Flows
Call flows from flows: flow-ref, sourceless flows, and HTTP composition.
Events and Queues
Broadcast with topics or load-balance work with queues.
Scheduled Jobs
Run flows on a cron schedule and write structured logs to files.
State
Web
Integrations
Build a Slack Bot
Receive Slack events, verify signatures, and reply to mentions.
Work with Notion
Handle Notion webhooks, query data sources, and render pages as Markdown.