deploy.target-dispatch ​
Dispatch queued deployments for a deployment target
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-deployments |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
deployment_target_uuid | uuid | Yes | — | — |
organization_uuid | uuid | Yes | — | — |
force | boolean | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
deployment_target_uuid | uuid | No | — | — |
organization_uuid | uuid | No | — | — |
force | boolean | No | — | — |
next_action | string | No | — | — |
dispatch_outcome | string | No | — | — |
dispatch_owner_workflow_uuid | string | No | — | — |
deployment_uuid | uuid | No | — | — |
deployment_workflow_uuid | string | No | — | — |
queue_block_reason | string | No | — | — |
readiness_result | json | No | — | — |
wait_started_at | string | No | — | — |
dispatched_at | string | No | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failed_at_state | string | No | — | — |
skipped_unsupported | integer | No | — | — |
unsupported_workflow_type | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | validate | Dispatcher started; resolve deployment target up front |
checking | No | No | — | — | Evaluate queue and target readiness |
dispatching | No | No | — | complete | Start queued deployment workflow |
validated | No | No | — | check | Deployment target resolved; scheduling queue check |
waiting | No | No | — | — | Queue blocked; waiting to re-check target readiness |
completed | No | Yes | Yes | — | No pending work or deployment dispatched |
failed | No | Yes | No | — | Dispatcher failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | validate | validated | Resolve deployment target; fail fast to failed if unknown |
validated | check | checking | Inspect queue and active target state |
checking | wait | waiting | Queue cannot proceed yet |
checking | dispatch | dispatching | Target is ready; dispatch next queued deployment |
checking | complete | completed | Nothing to dispatch |
waiting | recheck | checking | Retry queue/readiness check after delay |
checking | recheck | checking | Re-run readiness check while staying in checking |
dispatching | complete | completed | Dispatch completed |
* (any state) | fail | failed | Move 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"
}
}