Schemas

What sort of actor: user for a person (actor is user:<clerk id>), app for an app's own key (actor is app:<id>), operator for any other recorded name, which is an operator token's configured name. Taken from the recorded actor, never from actorName.

What to show for the actor: a person's name where one is known, otherwise the same text as actor. Always present. A person chooses their own name, so it is a label and never an identity: show it with actorKind.

What to do to every matching run.

Answer with just a count, and start nothing.

default false

redrive only: restart from this step rather than where the run failed.

Recorded on every run this touches.

max length 1000

rewind only, and required: the step to rewind to.

rewind only: the workflow version to rewind onto.

min 1 · max 2147483647

max length 1000

max length 1000

Every label a series of this metric carries, in order. Always starts with app and workflow.

Prometheus-compatible: snake_case with a foliot_ prefix; a counter ends in _total.

rollup: counted into minute, hour and day buckets from Foliot's own tables, so it has history; live: read at the moment it is asked, so it has none yet.

counter: a count per bucket, which only adds up; gauge: a value at an instant.

What one unit of the value is: runs, attempts, seconds.

The start of the bucket (UTC), or for a live gauge the moment it was read.

A counter's running total from the first bucket of the range through this one. Absent for a gauge.

A counter's count in this bucket; a gauge's value.

The value of each of the metric's labels.

For a rollup metric, one point for every bucket in the range, zero where nothing was counted. For a live gauge, one point.

A counter's sum over the whole range. Absent for a gauge.

The operator's name, from FOLIOT_OPERATOR_TOKENS.

Whether this person may make their own first workspace with POST /me/workspaces: they have never belonged to one. false for a person who belongs to a workspace and for one who was removed from theirs, so a screen offers the form only to someone the server will accept. Read now, after any invitation has joined them.

Why. Optional; recorded with the action.

max length 1000

Defaults to the run's current step.

max length 1000

max length 500

Where tasks are pushed.

The app's name. With POST /apps it also becomes the app's id; in a workspace the id is generated and the name only has to be unique in that workspace. Lower-case kebab.

min length 1 · max length 100 · pattern ^[a-z0-9][a-z0-9-]*$

max length 1000

min length 1

min 1 · max 2147483647

Matched against a retry policy's retryOn. Engine-set classes include timeout, wait_timeout, run_timeout and cancelled; handlers may set their own.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for choice.evaluated.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for run.cancelled.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for run.compacted.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for run.failed.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for run.redriven.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for run.repinned.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for run.rewound.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for run.sleeping.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for run.started.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for run.stuck.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for run.succeeded.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for run.waiting.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for signal.received.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for state.edited.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for step.completed.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for step.exhausted.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for step.parked.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for step.released.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for step.skipped.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for step.started.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for task.acked.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for task.completed.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for task.dispatched.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for task.failed.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for task.timed_out.

Position within this run's history, starting at 1.

foliot for engine actions, otherwise the operator name.

Bumped by redrive and rewind, so re-runs of a step stay distinguishable.

Monotonic across the engine; use seq for per-run ordering.

Payload written for wait.timed_out.

Position within this run's history, starting at 1.

Why. Required, and recorded.

min length 8 · max length 1000

Dedupe key. A repeat with the same key is reported duplicate, not delivered again.

max length 200

min length 1 · max length 100

min length 1

Dedupe key. A repeat with the same key is reported duplicate, not delivered again.

max length 200

min length 1 · max length 100

min length 1

Overrides the placeholder, for a step whose output the next one needs.

min length 1 · max length 1000

Your own identifier, for signalling later without tracking run ids.

max length 200

max length 200

max 20 items

min 1 · max 2147483647

min length 1

max length 1000

min 0.1 · max 10000

Being worked on right now.

Parked on a sleep step.

Unfinished runs sitting at this step.

Parked on a wait step, or on an async task.

Override the definition's next step. Must name a real step or a sentinel.

max length 100

After this the attempt is abandoned as timed out.

{runId}:{generation}:{step}:{attempt}.

The run's input.

Earlier steps' outputs, keyed by step name.

Complete or fail the task with this.

W3C traceparent whose trace id is the run id.

max length 500

max length 1000

min length 1 · max length 100 · pattern ^[a-z0-9][a-z0-9-]*$

min 1 items · max 200 items

min 1 · max 2147483647

Run counts keyed by status; statuses with no runs are absent.

Runs that reached failed in the last 24 hours.

Age of the oldest due-but-unprocessed run. The scheduler-lag signal.

The person's Clerk user id (user_...): what the credential history records as user:<id>.

Absent until the person's profile has been mirrored from Clerk.

Absent until the person's profile has been mirrored from Clerk.

Foliot's id for the person: the id the role and removal routes take.

How many apps it holds.

How many people belong to it, in any role.

How many of them are owners.