Skip to content
Proud to collaborate with Microsoft for Startups

neon.project.provision ​

End-to-end Neon project creation: create at provider, persist, optional dev branch

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-neon
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
namestringYes—Neon project name
region_idstringNo—Neon region id; default aws-us-east-2
pg_versionintegerNo—Postgres major version; default 16
create_dev_branchbooleanNo—If True, create a non-primary dev branch after provision
dev_branch_namestringNo—Name for the dev branch; default 'dev'
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
namestringYes—Neon project name
region_idstringNo—Neon region id; default aws-us-east-2
pg_versionintegerNo—Postgres major version; default 16
create_dev_branchbooleanNo—If True, create a non-primary dev branch after provision
dev_branch_namestringNo—Name for the dev branch; default 'dev'
actorstringNo——
neon_project_idstringNo——
neon_default_branch_idstringNo——
neon_operation_idstringNo——
neon_project_uuiduuidNo——
neon_default_branch_uuiduuidNo——
neon_branch_idstringNo——
neon_dev_branch_uuiduuidNo——
created_atstringNo——
persisted_atstringNo——
branch_created_atstringNo——
branch_persisted_atstringNo——
provisioned_atstringNo——
failed_atstringNo——
auto_advancestringNo—Optional next-action override used by conditional short-circuits
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name
failure_typestringNo—Engine-stamped failure category (atomic path)
failed_actionstringNo—Engine-stamped action method that raised (atomic path)

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—createInputs accepted
creatingNoNo—persistCreating project at Neon + awaiting create operation
creating_branchNoNo—persist_branchCreating + awaiting dev branch
persistingNoNo—create_dev_branchPersisting NeonProject row
persisting_branchNoNo—completePersisting NeonBranch row
completedNoYesYes—Project provisioned
failedNoYesNo—Provision failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedcreatecreating—
creatingpersistpersisting—
persistingcreate_dev_branchcreating_branch—
creating_branchpersist_branchpersisting_branch—
persisting_branchcompletecompleted—
* (any state)failfailed—

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"
  }
}