Skip to content
Proud to collaborate with Microsoft for Startups

neon.connection.validate ​

Validate a Neon connection (API key) and record the result

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-neon
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
actorstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
cloud_connection_uuiduuidYes——
actorstringNo——
validbooleanNo——
neon_user_idstringNo——
neon_emailstringNo——
validated_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—validateInputs accepted
validatingNoNo—completeCalling neon.auth.validate_token
completedNoYesYes—Connection validated
failedNoYesNo—Validation failed

State Diagram ​

Transitions ​

FromActionToDescription
initiatedvalidatevalidating—
validatingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "neon.connection.validate",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value"
  }
}