#The Workflow Step object
Models a node in the Linkbreakers workflow canvas, defining what should occur after a scan (redirects, gates, forms) and how it connects to other steps in the visitor journey.
canvasPosition
objectCanvas position for React Flow node positioning
childStepIds
array<string>Child workflow step IDs (steps that this step can transition to, UUID)
createdAt
string (date-time)When the workflow step was created
eventAction
string (enum)This workflow step doesn't contain the redirection itself, because it's handled by the CLIENT_REDIRECT step itself.
Allowed values
EVENT_ACTION_UNSPECIFIEDEvent action not specified
EVENT_ACTION_CLIENT_REDIRECTRedirect visitors to a destination URL
EVENT_ACTION_QRCODE_SCANEntry step triggered when the QR code is scanned.
EVENT_ACTION_PASSWORD_VERIFYRequire visitors to enter a password before proceeding
EVENT_ACTION_FORM_SUBMITPresent a data collection form to visitors
id
stringThe unique identifier of the workflow step (UUID)
kind
string (enum)The kind of workflow step (entry, exit, etc.) - read-only, determined by server
Allowed values
KIND_UNSPECIFIEDWorkflow step kind not specified
KIND_ENTRYEntry steps are automatically triggered when a visitor reaches the workflow
KIND_EXITExit steps finalize the workflow (commonly a redirect)
KIND_INTERACTIVEInteractive steps require visitor input (forms, passwords, etc.)
linkId
stringThe link ID this workflow step belongs to (UUID)
parentStepIds
array<string>Parent workflow step IDs (steps that can transition into this step, UUID)
payload
objectWorkflow step payload - uses oneof for type safety based on EventAction
updatedAt
string (date-time)When the workflow step was last updated