Introduction
Foliot is a hosted workflow orchestrator. It keeps the workflow state, timing and the history, while your app owns the business logic. You describe each workflow once, in a versioned definition, and start runs against it. Foliot calls your service for each task over signed HTTPS (or offers it to pull workers), handles retries and timers, and keeps a full history of each run.
Key Foliot concepts include:
- A workflow which is a versioned list of different types of steps:
task,sleep,wait,choice. - A run is a single execution of a given workflow. It is basically a record that says “I am at step X of this workflow, which is due at time T, and I am on attempt N”.
Foliot routes each task to your app over signed HTTPS (or offers it to pull workers), records everything that happens, waits for timers and signals, and in case of hiccups retries with backoff. Furthermore, it lets operators redrive, rewind, skip, pause a step or bulk-repair thousands of runs from the Foliot Console when needed.
Start here
Foliot consists of four components:
- Foliot API (
https://api.foliot.app): the engine and the REST API that your app and the SDK talk to. - Foliot Console (
https://foliot.app): the web console to manage your apps, workflows and runs. See Managing runs. - Node.js SDK (
@foliot/sdk) - optional: Node.js client and thefoliotCLI. You need to use the REST API and implement the handler contract yourself if your service is developed using another programming language . - Your app: which owns the business logic and exposes HTTPS routes that Foliot calls for each task.