← All resources

Resource

custom_workflow_action

A tenant-defined action backed by a Script, invocable from workflows and the UI.

GraphQL reference →

Configuration

nameString!Required

Machine-readable slug, unique per tenant. Must match ^[a-z][a-z0-9_-]{0,63}$.

labelString!Required

Human-readable display name shown in the UI. Required.

descriptionStringOptional

Optional tooltip / documentation text, max 1000 characters.

iconStringOptional

Optional Lucide icon name used to render the action, max 64 characters.

scriptIdScriptID!Required

TypeID (prefix scr) of the Script implementing the action. Must reference a script in this tenant.

References script

configSchemaStringOptional

Optional JSON Schema document (as a JSON string) describing the action's configuration.

isActiveBoolean!Optional

Soft enable/disable toggle. Defaults to true when omitted.

Read-only values

Show values
idCustomWorkflowActionID!Read only

TypeID of this custom action, prefix cac (e.g. "cac_01K…").

computed by the platform

pinnedScriptContentStringRead only

Frozen snapshot of the script source taken when the action was pinned. Null means the action is unpinned and always executes the live script content.

computed by the platform

createdAtString!Read only

ISO-8601 timestamp of when the action was first created.

computed by the platform

updatedAtString!Read only

ISO-8601 timestamp of the last successful write to the action; equal to createdAt until it is first updated.

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.