Creating Your First Workflow¶
Create a minimal workflow without an embedded invocation, plus a separate HTTP trigger. Mirror the repo pattern: flows/workflows/minimal.yaml + flows/triggers/minimal-http.yaml.
1. Workflow (steps only)¶
Create flows/workflows/minimal.yaml (or copy the repo file):
# Start contracts live in ../triggers/*.yaml — workflow: message formats + steps only.
name: minimal
group: General
payload_format: auto
response_format: auto
example_payloads:
- name: dashboard-test-minimal
payload:
xml: "<root/>"
steps:
- id: ready
type: log
level: info
message: "Minimal workflow — add service_call steps for real integrations."
Schema notes:
nameandgroupidentify the workflow (group organizes in the dashboard).- Do not put
invocationon the workflow — start contracts are separate trigger docs. payload_format/response_formatare workflow-level message hints (auto|xml|json|raw).- Each step needs a unique
id(notname).
2. HTTP trigger (public path)¶
Create flows/triggers/minimal-http.yaml:
name: minimal-http
target_workflow: minimal
group: General
description: Gateway HTTP entry (merged with other triggers on the same workflow).
example_payloads:
- name: minimal-probe
payload:
xml: "<probe><source>dashboard-trigger-test</source></probe>"
invocation:
type: http
http_method: POST
gateway_public_path: /v1/api/minimal
gateway_auth_mode: none
policy_chain: []
Optional: add a schedule start for the same workflow (flows/triggers/minimal-scheduled.yaml with invocation.type: schedule) — see Triggers and Schedules.
3. Deploy or reload¶
- Deploy via your normal GitOps/CI flow, or
- Reload orchestrator runtime after a local update.
4. Run the workflow¶
Public / intended path — gateway route from gateway_public_path:
curl -X POST http://localhost:8080/v1/api/minimal \
-H "Content-Type: application/xml" \
-d '<root/>'
Internal — orchestrator (cluster / admin access):
curl -X POST http://orchestrator:8080/run/minimal \
-H "Content-Type: application/xml" \
-d '<root/>'
Gateway POST /v1/run/{name} is a legacy/dev alias and may be disabled (trigger-only gateway). Prefer /v1/api/... from triggers, or orchestrator POST /run/{name} for internal runs. Dashboard can also start a run from the workflow’s example payloads.
5. Verify execution¶
- Check traces via Gateway (
/v1/traces) or the Dashboard. - Confirm the workflow appears in Orchestrator
GET /workflows.