Skip to content
Proud to collaborate with Microsoft for Startups

ticket.plan.acknowledge ​

Acknowledge a proposed fix plan — the required gate before it can be applied.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-tickets
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes——
plan_uuidstringNo——
ticket_uuidstringNo——
actor_typestringNo——
actor_uuidstringNo——
commentstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
plan_uuidstringNo——
ticket_uuidstringNo——
statusstringNo——
changedbooleanNo——
organization_uuidstringNo—Input field preserved in workflow state.
actor_typestringNo—Input field preserved in workflow state.
actor_uuidstringNo—Input field preserved in workflow state.
commentstringNo—Input field preserved in workflow state.
failed_atstringNo—ISO-8601 timestamp when action_fail recorded the failure
failure_reasonstringNo—Human-readable failure reason from action_fail
failure_typestringNo—Engine-stamped failure category
failed_actionstringNo—Engine-stamped action that raised
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerstringNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—executeAccepted
executingNoNo—completeApplying the mutation
completedNoYesYes—Done
failedNoYesNo—Failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedexecuteexecutingRun the mutation
executingcompletecompletedFinalize
* (any state)failfailedCatch-all failure

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "ticket.plan.acknowledge",
  "initial_data": {
    "organization_uuid": "value"
  }
}