Skip to content
Proud to collaborate with Microsoft for Startups

deploy.target-dispatch ​

Dispatch queued deployments for a deployment target

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-deployments
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
deployment_target_uuiduuidYes——
organization_uuiduuidYes——
forcebooleanNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
deployment_target_uuiduuidNo——
organization_uuiduuidNo——
forcebooleanNo——
next_actionstringNo——
dispatch_outcomestringNo——
dispatch_owner_workflow_uuidstringNo——
deployment_uuiduuidNo——
deployment_workflow_uuidstringNo——
queue_block_reasonstringNo——
readiness_resultjsonNo——
wait_started_atstringNo——
dispatched_atstringNo——
completed_atstringNo——
failed_atstringNo——
failed_at_statestringNo——
skipped_unsupportedintegerNo——
unsupported_workflow_typestringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—validateDispatcher started; resolve deployment target up front
checkingNoNo——Evaluate queue and target readiness
dispatchingNoNo—completeStart queued deployment workflow
validatedNoNo—checkDeployment target resolved; scheduling queue check
waitingNoNo——Queue blocked; waiting to re-check target readiness
completedNoYesYes—No pending work or deployment dispatched
failedNoYesNo—Dispatcher failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedvalidatevalidatedResolve deployment target; fail fast to failed if unknown
validatedcheckcheckingInspect queue and active target state
checkingwaitwaitingQueue cannot proceed yet
checkingdispatchdispatchingTarget is ready; dispatch next queued deployment
checkingcompletecompletedNothing to dispatch
waitingrecheckcheckingRetry queue/readiness check after delay
checkingrecheckcheckingRe-run readiness check while staying in checking
dispatchingcompletecompletedDispatch completed
* (any state)failfailedMove dispatcher to failed

API Usage ​

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

{
  "workflow_type": "deploy.target-dispatch",
  "initial_data": {
    "deployment_target_uuid": "value",
    "organization_uuid": "value"
  }
}