Documentation
Build, run, and recover durable workflows on servers and mobile devices. Choose the task you have now; the full reference is below.
What do you want to do?
0.7.1 stable · Use this guide for released binaries and containers.
Release guide →Current main is unreleased · Local Studio, new authoring tools, and portable agent handoff are available in source.
Preview main →How recovery works
The engine saves execution state at durable boundaries. After a restart, it reads the saved state and continues eligible work. Your handlers keep their normal code; effect receipts and idempotency keys help you inspect side effects before retrying them.
Recommended learning path
Getting Started
Current Release — 0.7.1
Current stable release, installation pins, and Apple mobile artifact fixes.
Quick Start
Install the engine and run a local sequence.
Authoring Tools
JSON Schema, code-first builders, LLM generation, MCP, and CI gates.
Use Cases
Cold outreach, notification cascades, payment retries, and more.
22 Patterns
Annotated sequence patterns for common workflows.
Reference
REST API
Curated REST guide plus links to the generated OpenAPI contract.
Defining Sequences
Block types, delays, rate limits, send windows, and context access.
Block Types
ForEach, SubSequence, Loop, Parallel, Race, Router, TryCatch, ABSplit.
Built-in Handlers
http_request, log, sleep, self_modify, llm_call, emit_event, and more.
Template Interpolation
{{context.data.email}}, fallback defaults, and expression support.
External Workers
Pull-based REST workers in any language with heartbeats and queue routing.
Concurrency & Rate Limits
Per-entity concurrency keys, idempotency, and sliding-window rate limits.
Versioning & Migration
Sequence versioning, hot migration, and dynamic step injection.
Portable Continuity
Effect safety, signed handoff, placement, provenance, checkpoints, what-if analysis, and live migration.
Advanced
Advanced Features
A/B splits, circuit breakers, SLA timers, interceptors, encryption.
Sessions
Group related instances under a named entity for lifecycle management.
AI Agents
llm_call, tool_call, human_review, ReAct loops, multi-agent delegation.
Mobile SDK
Run workflows on iOS and Android. Offline-first, push-driven sync, server-side approvals.
Plugins & WASM
gRPC sidecar plugins, WASM sandboxed handlers, plugin registry.
Triggers
HTTP webhooks, NATS subscriptions, file watch, in-process event bus.
Credentials & Keys
Encrypted credential vault with OAuth2 refresh and credentials:// URIs.
Signals & LLM Usage
Pause, resume, cancel, custom signals, and LLM token tracking.
Resource Pools
Multi-resource distribution with weighted rotation and warmup ramps.
Streaming & Approvals
SSE real-time events and human-in-the-loop approval workflows.
Activepieces (200+ Apps)
Pre-built integrations with Slack, Gmail, Notion, HubSpot, and more.
SQLite & Test Mode
Zero-dependency local dev and in-memory CI testing.
CLI
Instance management, sequence operations, cron, and health checks.
Concepts & Operations
Core Concepts
Sequences, instances, blocks, signals, context, rate limits, recovery.
Comparison
How Orch8 compares to Temporal, Inngest, and Trigger.dev.
Configuration & Deployment
TOML config, environment variables, Docker, Helm, observability.
Cluster & Multi-Node
Horizontal scaling with database-level work distribution.
Circuit Breakers & DLQ
Automatic circuit breaking and dead letter queue for failed instances.
Architecture
Crate structure, snapshot execution, two execution paths, tech stack.
Database Schema
Core tables, indexes, migrations, and the scheduling hot path.
Glossary
Key terms used throughout the documentation and API.
Ready to try Orch8?
One command to install. Then run your first local sequence.
curl -fsSL https://orch8.io/start.sh | sh