Skip to content
Proud to collaborate with Microsoft for Startups

data.appdata.record.write ​

Create an owner-scoped appdata record from a declared virtual table (routes to the app's storage plane: the shared appdata store, or the app's own Postgres instance when it has one)

Create an owner-scoped appdata record.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-appdata
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Authenticated organization UUID
identity_app_uuiduuidNo—(server-resolved principal from the end-user token; input ignored unless it agrees)
database_slugstringNo—Virtual database slug. Optional when the authenticated app has exactly one serving database; required when the app has zero or many.
table_slugstringYes—Virtual table slug
end_user_uuiduuidNo—(server-resolved principal from the end-user token; input ignored unless it agrees)
app_organization_uuiduuidNo—(server-resolved active workspace for organization-mode tables; input rejected if it disagrees)
resource_refstringNo—Optional resource identifier for fine-grained workspace capability checks (ns:verb:resource_ref)
request_idstringNo—Caller request id for audit correlation
actorstringNo—Workflow caller or agent identifier
payloaddictYes—User-declared field payload
idempotency_keystringNo—Optional caller idempotency key

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID echoed from input
identity_app_uuiduuidYes—Identity app UUID echoed from input
database_slugstringYes—Virtual database slug
table_slugstringYes—Virtual table slug
record_uuiduuidYes—Created record UUID
owner_end_user_uuiduuidYes—Owner forced from end_user_uuid
createdbooleanYes—True when a new record was inserted
written_atstringYes—ISO-8601 write timestamp
failure_reasonstringNo—Engine-stamped failure reason
failed_at_statestringNo—State when the workflow failed
failed_stepstringNo—Failed DAG step name
failed_layerintegerNo—Failed DAG layer index
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeWrite record
completedNoYesYes—Written
failedNoYesNo—Write failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
writtenSUCCESSCreate an owner-scoped appdata record from a declared virtual table (routes to the app's storage plane: the shared appdata store, or the app's own Postgres instance when it has one)record_uuid
failedFAILUREAppdata workflow failedfailure_reason

API Usage ​

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

{
  "workflow_type": "data.appdata.record.write",
  "initial_data": {
    "organization_uuid": "value",
    "table_slug": "value",
    "payload": "value"
  }
}