LogoLogo
Back to studio
  • Formsort documentation
  • โฉQuickstart
    • ๐ŸŸขGet started with Formsort
    • ๐ŸŽCore concepts
    • โ„น๏ธQuestion and content reference
    • ๐Ÿ“•Key terms
    • ๐Ÿž๏ธCreate your first flow
    • ๐Ÿ“–Add content and collect answers
      • ๐ŸคณCapture demographic data
      • โ„น๏ธAdd informational content
      • ๐Ÿ” Review your variable schema
    • ๐ŸŽจCreate a theme
      • Set brand guidelines
    • ๐ŸคนPersonalize your flow
      • ๐ŸŒŸTemplate your variables
      • ๐Ÿง Add conditional logic
      • ๐Ÿ’ซUsing conditional logic with Calculated and API variables
      • ๐Ÿ”šEnd the flow
    • ๐Ÿ”€Set up integrations
    • ๐Ÿš€Go live
      • Auditing your flow for content, functionality, and design
    • ๐Ÿ’ผCommon use cases
      • ๐Ÿ’”Disqualify responders
      • ๐Ÿ—“๏ธAdd a scheduling option
      • ๐Ÿ“„Allow responders to read and accept your company policies
  • ๐Ÿ—๏ธBuilding flows
    • Flows and variants
      • Flow starts
    • Adding content
      • Groups
      • Steps
        • Settings
        • Logic
        • Style
      • Questions
        • General Settings
        • Style
        • Address
        • Comparison
        • Confirmation
        • Date
        • Date & Time
        • Email address
        • File upload
        • Grid choice
        • Iframe
        • Image upload
        • Number
        • Payment
        • Phone number
        • Postal code
        • Question group
        • Region
        • Select
          • Providing choices via API or calculation
        • Signature
        • SSN
        • Text questions
        • Yes/No
      • Content
        • General Settings
        • Statement
        • Image
        • Video
        • Next button
        • Divider
        • Map
      • Endings
      • Using markdown
      • Using variable templating
        • Template formatting functions
      • Copy-pasting form content
      • Content library
    • Conditions and logic
      • Logical operator reference
      • Advanced logic
    • Variables (answers)
      • Variables from questions
      • Externally provided variables
      • Calculated variables
      • API lookups
      • System Library variables
      • Orphaned variables
    • Schemas
      • JSON Schemas
      • Validating flow schemas
    • Redirects
    • Styling and themes
      • CSS Reference
      • Overriding theme styling
      • Custom CSS overrides
      • Content area
      • Animations and transitions
      • Form Layout
      • Typography
        • Adobe Fonts
        • Hosting custom fonts
      • Color variables
      • Dimension variables
      • Question containers
      • Assets
      • Form Buttons
        • Select buttons
      • Inputs and dropdowns
      • Checkmarks
      • Tables
      • Sliders
      • Divider lines
      • Progress bar
      • Comparison cards
    • Variant settings
      • Form behavior for returning responders
      • Group ranking API
    • Publishing and versions
      • Preview window
      • Deploying
      • History
  • ๐Ÿ’พHandling data
    • Philosophy and data retention policy
    • Viewing form answers
    • Responder UUIDs
    • Environments
      • Loading different environments
    • Passing data in
      • URL parameters
      • POST body
      • Embed query parameters
    • Custom validators
    • Form answers and events
      • Analytics events
      • Signed requests
      • Event payload shape
      • Submission frequencies
      • Runtime error reporting
      • Admin API
      • Flow content data format
    • Integration reference
      • Amplitude
        • Amplitude cross domain tracking
      • BigQuery
      • FullStory
      • Google Analytics
        • Updating from Universal Analytics to GA4
      • Google Cloud Storage
      • Google Sheets
      • Google Tag Manager (GTM)
        • JavaScript triggered by flow events
      • Hubspot
      • Jornaya
      • Optimizely
      • PostgreSQL
      • Redshift
      • Rudderstack
      • S3
      • Salesforce
      • Segment
        • Segment Setup
        • Segment cross domain tracking
      • Stripe
      • TrustedForm
      • Webhooks
        • Zapier
  • ๐Ÿ“บGoing live
    • Custom domains
    • Built-in analytics
    • Embedding
      • Web-Embed API
        • React-embed
      • Adding authentication
      • Embedding forms in iOS and Android
      • Setting up a dev environment
    • Split testing
    • Preflight checklist
  • ๐ŸขTeams
    • Accounts
      • Roles and permissions
    • Events subscriptions
    • Workspace domain detection
Powered by GitBook
On this page
  • Overview of the System Library
  • Available answer definitions
  • Amplitude device ID
  • current group ID
  • current step ID
  • current step index
  • current step URL
  • expected redirect url
  • flow label
  • Formsort environment
  • host
  • is Android?
  • is iOS?
  • is Mac OS?
  • is mobile
  • is returning responder
  • is Windows?
  • Jornaya lead ID
  • previous step url
  • referrer
  • responder UUID
  • session UUID
  • Trusted Form certificate URL
  • user agent
  • variant label
  • variant revision UUID

Was this helpful?

  1. Building flows
  2. Variables (answers)

System Library variables

Built-in answers about the responder's context and state.

PreviousAPI lookupsNextOrphaned variables

Last updated 5 months ago

Was this helpful?

Overview of the System Library

System Library variables allow access to built-in attributes about the responder's environment or context. They allow you to reach into the internals of Formsort, or the responder's browser, and pull out information that may be useful to you, like user device or OS, or the label of the the user is visiting.

Available answer definitions

Amplitude device ID

Sends the Amplitude device ID, if the device ID was set in the URL and the Amplitude integration is active with "Use device id from URL" enabled.

current group ID

current step ID

current step index

The index of the current step, which is the number automatically assigned to the step according to where it is in the flow (e.g. first step is step "0", second step is step "1", etc.). The step index cannot be manually set.

current step URL

The URL for the current step, including the page index (https://{flow-url}#1 for the first step of a page).

expected redirect url

Where is the user getting redirected?

Will be set even if not currently redirecting: this is where the responder would be redirected at any point in the flow.

When the flow is being finalized, this is the same as the URL they were finally redirected to.

flow label

The string label identifying the flow that was loaded.

Formsort environment

host

This variable will include the base flow url in the answer payload.

is Android?

Is the responder on an Android device?

Useful as a condition for displaying an Play Store link if you have an app.

is iOS?

Is the responder on an iOS device, such as an iPhone?

Useful as a condition for displaying an App Store link if you have an app.

is Mac OS?

Is the responder on Mac OS?

is mobile

Is the responder on a mobile device, regardless of manufacturer?

is returning responder

Has the responder been to this flow before?

is Windows?

Is the responder on Windows OS?

Jornaya lead ID

previous step url

The URL of the previous step, useful for back links.

referrer

The URL that form user arrived from, corresponding to document.referrer.

Take care with collecting the referrer: it may contain personally-identifying information, if the referring page puts user data in its own URL and does not have a Content Security Policy defined.

responder UUID

session UUID

The UUID of the session, unique for every time a flow is loaded. Reloading the browser or navigating back to the page will create a new UUID.

Trusted Form certificate URL

user agent

Navigator user agent, meaning the browser the responder is using. Includes version number.

variant label

The string label identifying the variant that was loaded.

variant revision UUID

The UUID of the variant revision that was loaded for the responder.


If you have any suggestions for our System Library chat us in Intercom!

Any variables added here will automatically be sent along with your answers to any integrations/configurations you have set up, and do not need to be added in-flow in any way. They can, of course, be templated using , or used in statements at your discretion.

The ID of the current the user is in (falling back to the Group Index if a Group ID has not been set).

The ID of the current step (falling back to the current step index if an ID is not set). The is useful to include if using any analytics integrations, in order to analyze step-level performance. This id can be manually set in the Step Settings.

If "Use step ID instead of index" is enabled in , the current step URL will instead look like https://{flow-url}#step-id.

Which is the responder in?

The Jornaya lead ID. Will only be set if you are using the in the active environment.

May be undefined if the user navigated directly to the flow, or if the referring page does not send the referrer per their .

The of the responder.

The URL of the Trusted Form certificate issued for the session. Read more about the Trusted Form integration .

๐Ÿ—๏ธ
variable templating
conditional logic
Group
Step ID
environment
Jornaya integration
Content Security Policy
responder uuid
here
Variant Settings
variant
System Library can be found in any variant, under Variables -> System Library