WorkflowDispatchDefinitions

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

GET /api/workflow-engine-api/workflow-dispatch-definitions

List workflow dispatch definitions

Lists definitions the caller's org owns. Filter by projectId and/or workflowSlug. Without projectId, both org-wide and project-scoped definitions are returned.

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

POST /api/workflow-engine-api/workflow-dispatch-definitions

Create a workflow dispatch definition

Saves a named overlay (revision / inputs / briefcase / walletRefs) for one workflow slug under the caller's org. Pass projectId to scope the definition to a single project; omit it for an org-wide definition.

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

Request body: application/json CreateWorkflowDispatchDefinitionDto

GET /api/workflow-engine-api/workflow-dispatch-definitions/{id}

Get a workflow dispatch definition by id

Returns the definition when it belongs to the caller's org. A cross-org or unknown id returns the same 404.

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

PATCH /api/workflow-engine-api/workflow-dispatch-definitions/{id}

Update a workflow dispatch definition

Mutates name and/or overlay. workflowSlug and scope are immutable — re-target by delete + create. An empty body is rejected.

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

Request body: application/json UpdateWorkflowDispatchDefinitionDto

DELETE /api/workflow-engine-api/workflow-dispatch-definitions/{id}

Delete a workflow dispatch definition

Removes the definition. A cross-org or unknown id returns 404. References to a deleted definition fail fast at dispatch time.

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