Skip to content
Proud to collaborate with Microsoft for Startups

neon.project.sync ​

Reconcile a Neon project's branches/roles/databases into local rows

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-neon
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
neon_project_uuiduuidYes——
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
neon_project_uuiduuidYes——
actorstringNo——
branches_syncedintegerNo——
roles_syncedintegerNo——
databases_syncedintegerNo——
endpoints_syncedintegerNo——
synced_atstringNo——
failed_atstringNo——
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—syncInputs accepted
syncingNoNo—completeReconciling provider state into local rows
completedNoYesYes—Project synced
failedNoYesNo—Sync failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedsyncsyncing—
syncingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "neon.project.sync",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value",
    "neon_project_uuid": "value"
  }
}