Workflow
/api/v1/workflowsA defined workflow with steps, conditions, and error handling.
listgetcreateupdatedeleterunSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | FK → UserUser id from the caller's JWT (sub). |
| updated_by | uuid | FK → UserUser id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | FK → UserUser id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| name* | string | Workflow name (unique per tenant). |
| description | string | Human-readable workflow description. |
| version | string | Semantic version. |
| status | enum | active | draft | archivedWorkflow status. |
| trigger | enum | manual | scheduled | event | webhookHow the workflow is triggered. |
| steps | json | Array of workflow steps with conditions and actions. |
| config | json | Workflow-level configuration. |
| error_handling | json | Error handling strategy (retry, skip, fail). |
| permissions | json | Required permissions to run this workflow. |
API
Loading manifest…