Appearance
CustomWorkflowActionState
Type: Object
A tenant-defined action backed by a Script, invocable from workflows and the UI.
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| configSchema | String | Optional JSON Schema (draft 2020-12) describing the action's per-invocation configuration; the workflow editor builds its form from this. Null when the action takes no configuration. Validated beyond the specification: an unrecognised keyword is refused rather than ignored, because one that is ignored here silently constrains nothing. | ||
| createdAt | String! | ISO-8601 timestamp of when the action was first created. | ||
| description | String | Optional tooltip / documentation text for the action, max 1000 characters. Null when the author supplied none. | ||
| icon | String | Optional Lucide icon name used to render the action in the UI, max 64 characters. Null when no icon was chosen. | ||
| id | CustomWorkflowActionID! | TypeID of this custom action, prefix cac (e.g. "cac_01K…"). | ||
| isActive | Boolean! | Soft enable/disable toggle. Inactive actions are retained but omitted from listAvailableActions. Defaults to true on create. | ||
| label | String! | Human-readable display name shown in the UI. Required. | ||
| name | String! | Machine-readable slug, unique per tenant and used to invoke the action. Must match ^[a-z][a-z0-9_-]{0,63}$ (lowercase letters, digits, '-', '_'). | ||
| pinnedScriptContent | String | 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. | ||
| scriptId | ScriptID! | TypeID (prefix scr) of the Script that implements the action. The script must exist in this tenant; writes are rejected otherwise. | ||
| updatedAt | String! | ISO-8601 timestamp of the last successful write to the action; equal to createdAt until it is first updated. |