← API reference
CANONICAL TYPE REFERENCE

CreateCustomWorkflowActionInput

Input for creating a custom action

nameString!

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

labelString!

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

Optional tooltip / documentation text, max 1000 characters.

iconString

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

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

True snapshots the script's current source into pinnedScriptContent, freezing the action against later script edits. False or omitted leaves the action unpinned, so it always runs the live script.

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

isActiveBoolean

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

View exact SDL
"""Input for creating a custom action"""
input CreateCustomWorkflowActionInput {
  """
  Machine-readable slug, unique per tenant. Must match `^[a-z][a-z0-9_-]{0,63}$`.
  """
  name: String!
  """Human-readable display name shown in the UI. Required."""
  label: String!
  """Optional tooltip / documentation text, max 1000 characters."""
  description: String
  """
  Optional Lucide icon name used to render the action, max 64 characters.
  """
  icon: String
  """
  TypeID (prefix `scr`) of the Script implementing the action. Must reference a script in this tenant.
  """
  scriptId: ScriptID!
  """
  True snapshots the script's current source into pinnedScriptContent, freezing the action against later script edits. False or omitted leaves the action unpinned, so it always runs the live script.
  """
  pinToCurrentScript: Boolean
  """
  Optional JSON Schema document (as a JSON string) describing the action's configuration.
  """
  configSchema: String
  """Soft enable/disable toggle. Defaults to true when omitted."""
  isActive: Boolean
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.