Actions

Operations of the Workflow Engine API. Paths are relative to your deployment's API host.

GET /api/workflow-engine-api/actions

List action definitions

Returns system-seeded actions plus any custom actions owned by the caller's org. Filter with ?isSystem=true for the v1 built-in catalog only, or ?isSystem=false for the caller-org custom actions only.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
isSystemquerybooleannoWhen true, returns only system-seeded actions. When false, only org-custom. Omit for both.
StatusDescriptionBody
200application/json ActionDefinitionResponseDtoDataArrayEnvelope

POST /api/workflow-engine-api/actions/versions

Publish a new action version (custom, org-scoped)

Validates the YAML, upserts the stable identity, automatically creates or reuses an immutable content-addressed revision, and queues its governed release. metadata.version is only a compatibility label; ordinary edits need no manual bump.

Authentication: bearer token (Authorization: Bearer <token>)

Request body: application/json PublishActionVersionDto

StatusDescriptionBody
201application/json ActionDefinitionVersionResponseDtoDataEnvelope

GET /api/workflow-engine-api/actions/{scope}/{name}

Get action definition by slug

Resolves a slug (e.g. xema/agent) to its definition. System actions are checked first; org-scoped custom actions match only when they belong to the caller's org.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
namepathstringyes
scopepathstringyes
StatusDescriptionBody
200application/json ActionDefinitionResponseDtoDataEnvelope

GET /api/workflow-engine-api/actions/{scope}/{name}/versions/{version}

Get a specific action version

Resolves the governed release, verifies its compatibility label (slug@version), and returns the immutable revision. The exact revision id and content hash are frozen into CompiledRun snapshots.

Authentication: bearer token (Authorization: Bearer <token>)

ParameterInTypeRequiredDescription
namepathstringyes
scopepathstringyes
versionpathstringyes
StatusDescriptionBody
200application/json ActionDefinitionVersionResponseDtoDataEnvelope