{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Workflow Variables","projectTitle":"Frontline Documentation","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"workflow-variables","__idx":0},"children":["Workflow Variables"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Workflow Variable"]}," is a named placeholder scoped to a single ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/workflows"},"children":["Workflow"]}," automation. You set or capture its value in one node and reference it later as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{VARIABLE_NAME}"]}," in any interpolable text field of the same workflow."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Workflow variables are scoped to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["one Workflow"]},". They are not visible to other workflows and not shared with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/flow-variables"},"children":["Flow Variables"]},", which live on Agents."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"identity","__idx":1},"children":["Identity"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["variableId"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Snake-case by convention. Used inside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{NAME}"]}," interpolation tags."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["enum"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACTIVE"]}," · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INACTIVE"]}," · ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ARCHIVED"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pattern"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional regex pattern. Used to validate captured values."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["defaultValue"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value used when the variable has not been set yet."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isDefault"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," for variables that ship with the platform."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["automationId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Owning workflow."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdAt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO timestamp."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updatedAt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO timestamp."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"where-they-interpolate","__idx":2},"children":["Where they interpolate"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reference variables as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{VARIABLE_NAME}"]}," in any interpolable text field. The name must match ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["exactly"]},", including case."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Interpolable fields inside a Workflow include everything available to Flow Variables, plus:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AI Capture"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prompt"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instructions"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data Transformer"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prompt"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Tools AI"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["instructions"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prompt"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Transcription"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["audioUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send Message"]}," / WhatsApp template variables: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateVariables.header"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateVariables.body"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateVariables.buttons"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"implicit-runtime-variables","__idx":3},"children":["Implicit runtime variables"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In addition to the variables you declare, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["every node automatically exposes a runtime variable equal to its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nodeId"]}]},". A node with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nodeId = \"api_1\""]}," is referenceable later as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{api_1}"]},". These do not appear in this resource — they are implicit."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the Workflow-only shortcut: in Flows you must declare a variable to carry a value forward; in Workflows you can chain nodes directly via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{nodeId}"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"naming","__idx":4},"children":["Naming"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use snake_case (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["order_id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customer_email"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Must be unique within the workflow. Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["check-name"]}," endpoint to test availability before creating."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reserved: don't shadow a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nodeId"]}," of another node in the same graph."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"operations","__idx":5},"children":["Operations"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Verb"},"children":["Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/workflows/{workflowId}/variables"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/workflows/{workflowId}/variables"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/workflows/{workflowId}/variables/{variableId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/workflows/{workflowId}/variables/{variableId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/workflows/{workflowId}/variables/{variableId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/workflows/{workflowId}/variables/all"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/workflows/{workflowId}/variables/check-name?name=..."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All endpoints require a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]}," API key. Full details under the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Workflow Variables"]}," tag in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/reference/openapi"},"children":["API Reference"]}]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"cli","__idx":6},"children":["CLI"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"frontline workflows variables list --table\nfrontline workflows variables create --name order_id --description \"Order ID\" --pattern \"^[0-9]+$\"\nfrontline workflows variables check-name order_id\nfrontline workflows variables update 123 --name order_id --pattern \"^[0-9]+$\"\n","lang":"bash"},"children":[]}]},"headings":[{"value":"Workflow Variables","id":"workflow-variables","depth":1},{"value":"Identity","id":"identity","depth":2},{"value":"Where they interpolate","id":"where-they-interpolate","depth":2},{"value":"Implicit runtime variables","id":"implicit-runtime-variables","depth":2},{"value":"Naming","id":"naming","depth":2},{"value":"Operations","id":"operations","depth":2},{"value":"CLI","id":"cli","depth":2}],"frontmatter":{"seo":{"title":"Workflow Variables"}},"lastModified":"2026-05-28T14:34:48.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/concepts/workflow-variables","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}