Skip to content
Proud to collaborate with Microsoft for Startups

data.connection.update_status ​

Update CloudConnection status via mark_* helpers

Update the status of a cloud connection via the model's mark_* helpers.

Input: organization_uuid, connection_uuid, new_status, optional status_message, optional account_info (honored on 'active' only). Output in state_data: connection_uuid, new_status, last_validated_at, validation_count, changed.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-connection
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization that owns the connection
connection_uuiduuidYes—UUID of the connection whose status is being updated
new_statusstringYes—One of active
status_messagestringNo—Optional human-readable status message
account_infodictNo—Provider account metadata (honored on 'active' only)

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—UUID of the connection whose status was updated
new_statusstringYes—Status after the update
last_validated_atstringNo—ISO-8601 timestamp of the last validation
validation_countintegerNo—Total number of validations performed
changedbooleanYes—True when the row was actually mutated
organization_uuiduuidNo—Organization UUID echoed from input
failure_reasonstringNo—Human-readable failure reason
failure_typestringNo—Failure category
failed_actionstringNo—Name of the action method that raised
failed_at_statestringNo—State the workflow was in when it failed
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name
failed_layerstringNo—Engine-stamped layer index (DAG path)
failed_stepstringNo—Engine-stamped step name (DAG path)

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeUpdate connection status
completedNoYesYes—Updated
failedNoYesNo—Update failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

API Usage ​

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

{
  "workflow_type": "data.connection.update_status",
  "initial_data": {
    "organization_uuid": "value",
    "connection_uuid": "value",
    "new_status": "value"
  }
}