Skip to content
Proud to collaborate with Microsoft for Startups

ticket.schedule ​

Register a one-shot or recurring trigger that fires a workflow under the ticket owner's authority.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-tickets
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes——
ticket_uuidstringYes——
kindstringYes——
run_atdatetimeNo——
starts_atdatetimeNo——
interval_secondsintegerNo——
action_workflow_typestringYes——
action_inputjsonNo——
action_authority_typestringNo——
action_authority_uuidstringNo——
overlap_policystringNo——
max_runsintegerNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
trigger_uuidstringNo——
next_run_atdatetimeNo——
organization_uuidstringNo—Input field preserved in workflow state.
ticket_uuidstringNo—Input field preserved in workflow state.
kindstringNo—Input field preserved in workflow state.
run_atdatetimeNo—Input field preserved in workflow state.
starts_atdatetimeNo—Input field preserved in workflow state.
interval_secondsintegerNo—Input field preserved in workflow state.
action_workflow_typestringNo—Input field preserved in workflow state.
action_inputjsonNo—Input field preserved in workflow state.
action_authority_typestringNo—Input field preserved in workflow state.
action_authority_uuidstringNo—Input field preserved in workflow state.
overlap_policystringNo—Input field preserved in workflow state.
max_runsintegerNo—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.schedule",
  "initial_data": {
    "organization_uuid": "value",
    "ticket_uuid": "value",
    "kind": "value",
    "action_workflow_type": "value"
  }
}