← All resources

Resource

workflow

A workflow definition that can have multiple versions

GraphQL reference →

Configuration

nameString!Required

Workflow name (required)

descriptionStringOptional

Workflow description

currentVersionIdWorkflowVersionIDOptional

Currently active version ID

References workflow_version

written by `setActiveVersion`, not by this resource's update

botUserIdUserIDOptional

Bot user ID for workflow execution identity

References service_account

defaultNodeTimeoutSecondsIntOptional

Default timeout for workflow nodes in seconds

isActiveBoolean!Optional

Whether the workflow is active (default: false)

Read-only values

Show values
idWorkflowID!Read only

Unique identifier

computed by the platform

tenantIdTenantID!Read only

Tenant ID

computed by the platform

createdAtISO8601!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtISO8601!Read only

Last update timestamp (ISO8601)

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.