x-cpod-domain: workflows

Workflows

Platform workflow engine — orchestrate multi-step processes with conditional logic and error handling.

Try in explorer client.workflows

Workflow

A defined workflow with steps, conditions, and error handling.

REST path/api/v1/workflows

Operations

listgetcreateupdatedeleterun

SDK

// list — returns only your records; add filters/search:
await client.workflows.list()

// create:
await client.workflows.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  name: "example name",
  app_id: "example app_id",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*	date-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid→User	User id from the caller's JWT (sub).
updated_by	uuid→User	User id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid→User	User id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
name*	string	Workflow name (unique per tenant).
description	string	Human-readable workflow description.
version	string	Semantic version.
status	enum	Workflow status.`activedraftarchived`
trigger	enum	How the workflow is triggered.`manualscheduledeventwebhook`
steps	json	Array of workflow steps with conditions and actions.
config	json	Workflow-level configuration.
error_handling	json	Error handling strategy (retry, skip, fail).
permissions	json	Required permissions to run this workflow.

Docs

Workflow