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
  • Allowing answer sending
  • Send answers
  • Send PII
  • Only send answers from current step
  • Paylod shape
  • Answers at root
  • Flatten answer keys
  • Stringify answers

Was this helpful?

  1. Handling data
  2. Form answers and events

Event payload shape

PreviousSigned requestsNextSubmission frequencies

Last updated 11 months ago

Was this helpful?

When sending , you have control over the shape of the payload received by the destination.

Allowing answer sending

Send answers

By default, answers are not included in analytics event payloads. This way, analytics providers can be used for tracking conversion and performance, without sending user data to third parties.

If send answers is checked, answer values will be nested in an "answers" object of the event payload.

Send PII

Only send answers from current step

If only send answers from current step is enabled, the payload will only contain answers to questions that appear on the current step.

To instead send the current, full state of the flow on load, enable Send all answers on FlowLoaded, which will include the entire answer state in the FlowLoaded event's answer payload.

Paylod shape

All analytics events will contain the flow label, variant label, variant revision UUID, and responder UUID.

{
  "first_name": "John Doe",
  "flowLabel": "<FLOW_LABEL>",
  "variantLabel": "<VARIANT_LABEL>",
  "variantUuid": "<VARIANT_UUID>",
  "responderUuid": "<RESPONDER_UUID>"
}

Answers at root

With answers at root checked, all the answer keys will be at the same level of nesting within the payload object.

{
  "address.raw": "123 Test St, Beverly Hills, CA 90210",
  "address.address_1": "123 Test St",
  "address.city": "Beverly Hills",
  "address.state": "CA",
  "address.postal_code": "90210",
  "utm_source": "facebook_ad",
  "first_name": "John Doe",
  "flowLabel": "<FLOW_LABEL>",
  "variantLabel": "<VARIANT_LABEL>",
  "variantUuid": "<VARIANT_UUID>",
  "responderUuid": "<RESPONDER_UUID>"
}

If unchecked, the answers will be nested within an answers object.

{
  "answers": {
    "address.raw": "123 Test St, Beverly Hills, CA 90210",
    "address.address_1": "123 Test St",
    "address.city": "Beverly Hills",
    "address.state": "CA",
    "address.postal_code": "90210",
    "utm_source": "facebook_ad",
    "first_name": "John Doe"
  },
  "flowLabel": "<FLOW_LABEL>",
  "variantLabel": "<VARIANT_LABEL>",
  "variantUuid": "<VARIANT_UUID>",
  "responderUuid": "<RESPONDER_UUID>"
}

Flatten answer keys

With flatten answer keys checked, nested answers, like arrays and objects, will be at the same level of nesting as all other answers:

{
  "answers": {
    "address.city": "Beverly Hills"
  }
}

With flatten answer keys unchecked, nested answers will remain in their original, nested shape.

{
  "answers": {
    "address": {
      "city": "Beverly Hills"
    }
  }
}

Stringify answers

When stringify answers is checked, the answers key itself will be a JSON string of the answers, rather than the nested object.

{
  "flowLabel": "<FLOW_LABEL>",
  "variantLabel": "<VARIANT_LABEL>",
  "variantUuid": "<VARIANT_UUID>",
  "responderUuid": "<RESPONDER_UUID>",
  "answers": "{\"address.raw\":\"123 Test St, Beverly Hills, CA 90210\",\"address.address_1\":\"123 Test St\",\"address.city\":\"Beverly Hills\",\"address.state\":\"CA\",\"address.postal_code\":\"90210\",\"utm_source\":\"facebook_ad\",\"first_name\":\"John Doe\"}"
}

If send answers is enabled, send PII will also send Personally Identifying Information along to the analytics provider. Answers are marked as PII using the in the schema editor.

When sending answers from the current step, by default you will not receive any answers that are present at the beginning of the flow, such as .

๐Ÿ’พ
external answers
analytics events
data classification
Payload shape configurations for the Google Tag Manager analytics integration.