#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.
attributeCapture
A step's opt-in to save values to the visitor's profile, so a workflow can record qualification without a form: a tapped choice, a milestone reached, or the context of the link that was scanned. Available on every step except conditions, which only route on what is already known. A failed password attempt or a skipped form saves nothing. On forms it saves on top of the answers, which forms already save.
backButton
A page step's optional back button: a secondary button under the page's main actions that returns the visitor to the previous page in their browser, exactly like the browser's own back button. Use it for "Back to menu" on a sub-page reached from a MULTI_LINK menu instead of wiring a connection back to the menu. It hides itself when there is no previous page in the journey, such as on the first page right after a scan, and it never shows on a step whose back_button_available is false. Available on page steps only: MESSAGE_PAGE, MULTI_LINK, CONTACT_CARD, SOCIAL_LINKS_PAGE, FORM_SUBMIT, PASSWORD_VERIFY and THANK_YOU_PAGE. It is not part of the step's payload: set it with the back_button field of workflow_steps_create or workflow_steps_update.
backButtonAvailable
Whether this step's back_button can ever show: the step is a page and some visitor reaches it after already seeing another page (a menu, a form, a password page). False on a page that comes straight after the scan, even through conditions, because a visitor there has no page to go back to. A back_button stored on a step where this is false is kept, so it shows again once the wiring puts a page before the step.
branches
Every exit of this step, with its current destination. This is the vocabulary for connecting the step: pass one of these branch_ids to workflow_steps_connect. An atomic step has exactly one branch, "next". A composite step has one per button, option or range, plus "else" for a condition's fallback. An exit step has none.
canvasPosition
Canvas position for React Flow node positioning
childStepIds
Child workflow step IDs (steps that this step can transition to, UUID)
createdAt
When the workflow step was created
eventAction
leads to a next step, not straight out. Records which button the visitor pressed, so use it over SOCIAL_LINKS_PAGE when that choice is worth measuring or when a branch needs to do more than redirect. This is the menu step: for several documents or PDFs, give each one a button connected to an OPEN_MEDIA step for media uploaded to the media library, or to a CLIENT_REDIRECT when the document is already hosted at a URL. the common case, not the only one: app stores, docs, booking pages and storefronts all work, and the name is the only thing about it that is social. It is an exit step, so the visitor leaves from here. Firefox...) or the in-app browser of the app a link was opened in (Instagram, TikTok, Facebook, LinkedIn...) or UNKNOWN. AGENT is an AI agent that names itself (GPTBot, Claude-User, Perplexity-User...). AUTOMATED is a browser driven by software, whoever is behind it: headless Chrome from its request, and a visible browser under automation once a link with the Advanced data collection level has read navigator.webdriver, from that device's next visit on. visitor automatically. It carries no list of destinations, so a page that should offer a choice between two or more places is not this step. Use SOCIAL_LINKS_PAGE when the choices leave for external URLs, or MULTI_LINK when each choice continues into more workflow. Never put links, documents or PDFs on it: it is a message, nothing else. an image (PNG, JPEG, WebP, SVG) or an MP4 video. The visitor is sent straight to the media, with no page of its own. Any media of the library can be opened: it is uploaded once and referenced by its media_id; swapping it means pointing the step at another media item, and the QR code never changes. their permission (composite: two branches, "location" when it was shared, "else" when it was refused, skipped or is unavailable). language it sends, matched on its two-letter ISO 639-1 base, so "fr" catches fr-FR and fr-CA) attributes (composite: two branches, "completed" when every required objective is known, "else" otherwise) (composite: one branch per variant, no "else"). Assignment is deterministic and sticky per device by default. See TrafficSplitPayload.
Allowed values
EVENT_ACTION_UNSPECIFIEDEvent action not specified
EVENT_ACTION_CLIENT_REDIRECTRedirect visitors to a destination URL
EVENT_ACTION_LINK_VISITEntry step triggered when the link is visited.
EVENT_ACTION_PASSWORD_VERIFYRequire visitors to enter a password before proceeding
EVENT_ACTION_FORM_SUBMITPresent a data collection form to visitors
EVENT_ACTION_CONTACT_CARDGenerate a vCard (VCF) response with contact information
EVENT_ACTION_MULTI_LINKA page of buttons where each one continues into more workflow: the button
EVENT_ACTION_VISIT_TYPE_CONDITIONRoute visitors based on whether it's a first or returning visit
EVENT_ACTION_COUNTRY_CONDITIONRoute visitors based on their country location
EVENT_ACTION_DAY_OF_WEEK_CONDITIONRoute visitors based on day of week
EVENT_ACTION_TIME_OF_DAY_CONDITIONRoute visitors based on time of day
EVENT_ACTION_DAY_OF_MONTH_CONDITIONRoute visitors based on day of month
EVENT_ACTION_SPECIFIC_DATE_CONDITIONRoute visitors based on specific calendar dates
EVENT_ACTION_SOCIAL_LINKS_PAGEA page of buttons that each leave for an external URL. Social profiles are
EVENT_ACTION_DEVICE_TYPE_CONDITIONRoute visitors based on device type (e.g. MOBILE, DESKTOP, TABLET)
EVENT_ACTION_DEVICE_PLATFORM_CONDITIONRoute visitors based on device platform / operating system (e.g. iOS, Android, macOS)
EVENT_ACTION_DEVICE_BROWSER_CONDITIONRoute visitors based on their browser: a browser family (Chrome, Safari,
EVENT_ACTION_DEVICE_BRAND_CONDITIONRoute visitors based on hardware brand (e.g. Apple, Samsung, Google)
EVENT_ACTION_DEVICE_ACTOR_CONDITIONRoute visitors based on actor classification: HUMAN, BOT, AGENT, AUTOMATED
EVENT_ACTION_VISITOR_DATA_CONDITIONRoute visitors based on their profile data or custom attributes
EVENT_ACTION_THANK_YOU_PAGEDisplay a final thank you / completion message (exit step)
EVENT_ACTION_MESSAGE_PAGEText with ONE way onward: a single button, or a timer that moves the
EVENT_ACTION_OPEN_MEDIAHand the visitor one piece of uploaded media, opened in their browser (exit step): a PDF,
EVENT_ACTION_LOCATION_REQUESTAsk the visitor for their precise location (GPS) through the browser, with
EVENT_ACTION_LANGUAGE_CONDITIONRoute visitors based on their phone or browser language (the first
EVENT_ACTION_CHAT_BOTA conversation with one of the workspace's agents that collects visitor
EVENT_ACTION_TRAFFIC_SPLITSplit visitors between 2 to 20 variants by percentage, for an A/B test
id
The unique identifier of the workflow step (UUID)
kind
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_INTERACTIONInteraction steps require visitor input (forms, passwords, etc.)
KIND_CONDITIONCondition steps evaluate logic and route to different next steps
linkId
The link ID this workflow step belongs to (UUID)
nextCanGoBack
Whether a page added after this step could show a back button: this step is a page, or a page comes before it. False for a step no visitor reaches.
nodeType
The node type says how many exits a step has. Whatever the answer, you connect every one of them the same way, with workflow_steps_connect: name the branch, name the step it leads to. Read a step's branches field for its branch ids. Example: a multi-link with 3 buttons has 3 branches, with the buttons' ids. A redirect has one branch, "next". A country condition has one branch per country plus "else". for a condition's fallback. Examples: MULTI_LINK, VISIT_TYPE_CONDITION, COUNTRY_CONDITION, DAY_OF_WEEK_CONDITION, TIME_OF_DAY_CONDITION, DAY_OF_MONTH_CONDITION, SPECIFIC_DATE_CONDITION, DEVICE_*_CONDITION, VISITOR_DATA_CONDITION (THANK_YOU_PAGE, CONTACT_CARD, SOCIAL_LINKS_PAGE, CLIENT_REDIRECT) are atomic but end the journey, so they have no branches at all. Examples: LINK_VISIT, PASSWORD_VERIFY, FORM_SUBMIT, MESSAGE_PAGE
Allowed values
NODE_TYPE_UNSPECIFIEDWorkflow step node type not specified
NODE_TYPE_COMPOSITEComposite steps have one exit per button, option or range, plus "else"
NODE_TYPE_ATOMICAtomic steps have exactly one exit, branch id "next". Exit steps
parentStepIds
Parent workflow step IDs (steps that can transition into this step, UUID)
payload
Workflow step payload - uses oneof for type safety based on EventAction
rendersPage
Whether visitors see this step as a page. Page steps take the options every page has, such as back_button; redirects and conditions do not.
updatedAt
When the workflow step was last updated