docs/elsa/getting-started.md

995 B

Getting started

The Elsa workflows engine is already wired into the app — there is nothing to install. Open the Elsa Flows page from the main menu.

Create a definition

  1. On Elsa Flows, click New.
  2. Pick a root template (empty or a starter graph).
  3. Give the workflow a name and save.

The definition list on /flows shows one row per definition (the latest version). Use the version filter in the list header to switch between Latest, Published, Draft and All versions.

Run it

Select a definition and press Run in the toolbar. A new run opens on the Runs page (/flows/runs), where you can follow the incident list, the journal and the execution call stack.

A definition must be published before the engine can execute it. Running a draft returns the engine's published version not found error.
{
  "definitionId": "hello-world",
  "version": "1.0.0",
  "isPublished": true
}