Skip to content
Proud to collaborate with Microsoft for Startups

ticket.external.sync.prepare ​

Validate provider and build the outbound sync payload (local DAG step).

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-tickets
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes——
ticket_uuidstringYes——
providerstringYes——
connection_uuidstringNo——
modestringNo——
sync_fieldslistNo——
commentstringNo——
idempotency_keystringNo——
dry_runbooleanNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
ticket_uuidstringNo——
providerstringNo——
provider_workflow_typestringNo——
provider_inputjsonNo——
dispatchbooleanNo——
provider_resultjsonNo——
warningslistNo——
organization_uuidstringNo—Input field preserved in workflow state.
connection_uuidstringNo—Input field preserved in workflow state.
modestringNo—Input field preserved in workflow state.
sync_fieldslistNo—Input field preserved in workflow state.
commentstringNo—Input field preserved in workflow state.
idempotency_keystringNo—Input field preserved in workflow state.
dry_runbooleanNo—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.external.sync.prepare",
  "initial_data": {
    "organization_uuid": "value",
    "ticket_uuid": "value",
    "provider": "value"
  }
}