Skip to main content

List Workflow Node Types

GET 
/api/automation/workflow-nodes

Catalog of every node type available for building workflow graphs. Use the type values here as nodes[*].type when creating or updating a workflow.

Required scope: settings:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Each definition describes the node's category (triggers, actions, logic, ...), its inputs and outputs, the schema of the data it emits (outputSchema), and the settings it accepts (key, type, whether required, and default value).

Three more fields are derived from the engine rather than declared by each node, so they always match what a run does:

  • preview — what a preview-mode run does with the node: runs (executes for real; it cannot change anything), skipped (never executes; its input passes straight through), or simulated (never executes; reports what it would have done). mutates is true whenever preview is not runs.
  • operators — on every conditions / switch_rules setting, the complete list of condition operators the engine evaluates. An operator outside this list does not error; it evaluates false.
  • availability — triggers only, computed for the current account: { "available": bool, "reason": string|null }. A trigger whose event no connected integration publishes (for example channel-order-imported without a TikTok Shop connection) reports available: false with a reason naming the alternative — a workflow on it would publish cleanly and never run.

Request​

Responses​

OK

Response Headers
    Content-Type