neon.project.provision ​
End-to-end Neon project creation: create at provider, persist, optional dev branch
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-neon |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
cloud_connection_uuid | uuid | Yes | — | — |
name | string | Yes | — | Neon project name |
region_id | string | No | — | Neon region id; default aws-us-east-2 |
pg_version | integer | No | — | Postgres major version; default 16 |
create_dev_branch | boolean | No | — | If True, create a non-primary dev branch after provision |
dev_branch_name | string | No | — | Name for the dev branch; default 'dev' |
actor | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
cloud_connection_uuid | uuid | Yes | — | — |
name | string | Yes | — | Neon project name |
region_id | string | No | — | Neon region id; default aws-us-east-2 |
pg_version | integer | No | — | Postgres major version; default 16 |
create_dev_branch | boolean | No | — | If True, create a non-primary dev branch after provision |
dev_branch_name | string | No | — | Name for the dev branch; default 'dev' |
actor | string | No | — | — |
neon_project_id | string | No | — | — |
neon_default_branch_id | string | No | — | — |
neon_operation_id | string | No | — | — |
neon_project_uuid | uuid | No | — | — |
neon_default_branch_uuid | uuid | No | — | — |
neon_branch_id | string | No | — | — |
neon_dev_branch_uuid | uuid | No | — | — |
created_at | string | No | — | — |
persisted_at | string | No | — | — |
branch_created_at | string | No | — | — |
branch_persisted_at | string | No | — | — |
provisioned_at | string | No | — | — |
failed_at | string | No | — | — |
auto_advance | string | No | — | Optional next-action override used by conditional short-circuits |
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 |
failure_type | string | No | — | Engine-stamped failure category (atomic path) |
failed_action | string | No | — | Engine-stamped action method that raised (atomic path) |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | create | Inputs accepted |
creating | No | No | — | persist | Creating project at Neon + awaiting create operation |
creating_branch | No | No | — | persist_branch | Creating + awaiting dev branch |
persisting | No | No | — | create_dev_branch | Persisting NeonProject row |
persisting_branch | No | No | — | complete | Persisting NeonBranch row |
completed | No | Yes | Yes | — | Project provisioned |
failed | No | Yes | No | — | Provision failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | create | creating | — |
creating | persist | persisting | — |
persisting | create_dev_branch | creating_branch | — |
creating_branch | persist_branch | persisting_branch | — |
persisting_branch | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "neon.project.provision",
"initial_data": {
"organization_uuid": "value",
"cloud_connection_uuid": "value",
"name": "value"
}
}