Appearance
network.enqueue-scope-syncs ​
Fan out network scope sync workflows
Start scope sync workflows for all discovered scopes in one account.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-network |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
network_account_uuid | uuid | Yes | — | — |
organization_uuid | uuid | Yes | — | — |
workflow_run_uuid | string | No | — | Engine-stamped parent run UUID (DAG step target) |
workflow_run_id | string | No | — | Engine-stamped DAG run ID (injected when used as a DAG step) |
wait_for_children | boolean | No | — | When true, wait for child scope sync terminal states |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
network_account_uuid | uuid | Yes | — | — |
organization_uuid | uuid | Yes | — | — |
workflow_run_uuid | string | No | — | — |
workflow_run_id | string | No | — | Engine-stamped DAG run ID (injected when used as a DAG step) |
wait_for_children | boolean | No | — | — |
fanout_started_at | string | Yes | — | — |
network_scope_sync_workflow_uuids | json | Yes | — | — |
pending_scope_sync_workflow_uuids | json | Yes | — | — |
completed_scope_sync_workflow_uuids | json | Yes | — | — |
failed_scope_sync_workflow_uuids | json | Yes | — | — |
started_scope_sync_count | integer | Yes | — | — |
skipped_scope_sync_count | integer | Yes | — | — |
completed_scope_sync_count | integer | Yes | — | — |
failed_scope_sync_count | integer | Yes | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failure_reason | string | No | — | Engine-stamped human-readable failure reason |
failed_at_state | string | No | — | Engine-stamped state when the workflow failed |
failed_step | string | No | — | Engine-stamped step name (DAG path) |
failed_layer | integer | No | — | Engine-stamped layer index (DAG path) |
error | string | No | — | Engine-stamped exception message |
error_type | string | No | — | Engine-stamped exception class name |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | fanout | — |
fanout | No | No | — | — | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | fanout | fanout | — |
fanout | child_done | fanout | — |
fanout | child_failed | fanout | — |
fanout | complete | completed | — |
fanout | fail_children | failed | — |
* (any state) | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
enqueued | SUCCESS | Fan out network scope sync workflows | — |
failed | FAILURE | Network workflow failed | failure_reason |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "network.enqueue-scope-syncs",
"initial_data": {
"network_account_uuid": "value",
"organization_uuid": "value"
}
}