LogoLogo
Back to studio
  • 🧠Core Concepts
    • Introduction to Formsort
    • Formsort quickstart guides
      • Add content and collect answers
      • Capture demographic data
      • Add informational content
      • Template your variables
      • Add conditional logic
      • Using conditional logic with Calculated and API variables
      • Add a scheduling option
      • End the flow
      • Review your variable schema
      • Set up integrations
    • How data works in Formsort
      • Responder UUIDs
    • Understanding flows
    • Versioning in Formsort (Deploying)
      • Variant revisions
      • Managing revisions
  • ✨Creating Flows
    • Building a new flow
      • Groups
      • Steps
      • Copy-pasting form content
  • Adding questions and content
    • Questions
      • Select
      • Text
      • Address
      • Comparison
      • Confirmation
      • Date
      • Date & time
      • Email address
      • File upload
      • Grid choice
      • Iframe
      • Image upload
      • Number
      • Payment
      • Phone number
      • Postal code
      • Question group
      • Region
      • Signature
      • SSN
      • Yes/No
    • Content
      • Statement
      • Image
      • Next button
      • Video
      • Divider
      • Map
  • Controlling the flow with conditions and logic
    • Advanced logic
  • Variable templating
  • Redirects and endings
  • Field validation
  • Flow and variant management
  • Content library
  • 🧬JSON Form Definition
  • JSON schemas
  • Validating flow schemas
  • Events subscriptions
  • Flow content data format
  • 🎨Styling
    • Customizing appearance
      • Content area & form layout
      • Buttons
      • Typography
      • UI states
      • Color and dimension variables
      • Question containers
      • Inputs and dropdowns
      • Checkmarks
      • Tables
      • Sliders
      • Divider lines
      • Progress bar
      • Comparison cards
      • Animations and transitions
  • CSS & Advanced Styling
    • Custom CSS overrides
    • Step styling
    • CSS reference
  • 🔁Form Behavior Settings
    • Variant settings
      • Form behavior for returning users
      • Group ranking API
    • Navigation sidebar
  • ⚙️Response Data Collection & Management
    • Schema (variables)
      • Variables from questions
      • Externally provided variables
      • Calculated variables
      • API lookups
      • System Library variables
      • Orphaned variables
  • Saving & retrieving responses
  • Importing Data
    • URL parameters
    • POST body
    • Embed query parameters
  • 📊Analytics and Attribution
    • Built-in analytics
    • Split testing
  • 🚀Publishing and Deployment
    • Live preview overview
    • Environments
      • Loading different environments
    • Embedding
      • Web-embed API
        • React-embed
      • Adding authentication
      • Embedding forms in iOS and Android
      • Setting up a dev environment
    • Pre-deployment checklist
  • 📁Workspace Management
    • Accounts
      • Roles and permissions
    • Custom domains
    • Workspace domain detection
  • 🛠️Formsort Admin API
    • Admin API
  • 🔌Integrations
    • Form answers and events
      • Analytics events
      • Signed requests
      • Event payload shape
      • Submission frequencies
      • Runtime error reporting
    • 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
Powered by GitBook
On this page
  • How Formsort uses identify()
  • Example track() payloads.
  • Sending form answers data to Segment
  • Hide IP

Was this helpful?

  1. Integrations
  2. Integration reference

Segment

Sending form events or answers data to Segment

PreviousSalesforceNextSegment Setup

Last updated 11 months ago

Was this helpful?

is by far the most dynamic integration option, which allows you to pick and choose other third - party providers to send data to within Segment.

How Formsort uses identify()

When the form flow loads, and a Segment integration is enabled, we will call segment's method, using the as the identification. The remaining events, using track() will also include the responder UUID.

If you are manually providing the responder's UUID, that will be used instead.

Alternatively, if you'd rather have identify called with the anonymous ID assigned by Segment, you can check Identify with anonymous ID. You will still have the responder UUID within the payload of the event if you need it to do some downstream correlations.

If you'd rather use the user's email as an identifying ID, you can set that option using Use email instead of uuid to identify users.

Use email instead of uuid to identify users is not recommended by Segment since it is easy to have email collisions.

Example track() payloads.

All events sent will include the flow label, , variant label, and variant UUID.

analytics.track('FlowLoaded', {
  answers: {},
  flowLabel: 'segment-test',
  responderUuid: '7f2ee814-6eb2-4607-a0f0-1ccb382dc0ba',
  variantLabel: 'main',
  variantUuid: '18d59d22-b4b4-4b62-a0f6-0e22861280f9'
});

In the preview window, events are normally not sent to third parties, but are instead logged. When you have Segment connected, you can also verify on the Segment side.

For step-aware flow events, such as StepLoaded or StepCompleted, the step index and step ID will also be sent. Step ID falls back to step index if an ID is not explicitly defined - we recommend setting Step IDs to facilitate analysis, as the index of steps may change over time.

analytics.track('StepLoaded', {
  answers: {},
  flowLabel: 'segment-test',
  responderUuid: '7f2ee814-6eb2-4607-a0f0-1ccb382dc0ba',
  stepId: 0,
  stepIndex: 0,
  variantLabel: 'main',
  variantUuid: '18d59d22-b4b4-4b62-a0f6-0e22861280f9'
});

Sending form answers data to Segment

By default, no answers are send to Segment.

If the answer state looks like:

{
  "email": "test@example.com",
  "favorite_cat": "Olivia",
}

answers will just be an empty object.

analytics.track('StepLoaded', {
  answers: {},
}

If you check Send answers, then all non-PII answers will be sent along with each event's metadata:

analytics.track('StepLoaded', {
  answers: {
    "favorite_cat": "Olivia",
  },
}
analytics.track('StepLoaded', {
  answers: {
    "email": "test@example.com",
    "favorite_cat": "Olivia",
  },
}

If Stringify answers object in payload is checked, the answers will be sent as a JSON string rather than a JSON object:

analytics.track('StepLoaded', {
  answers: '{"email": "test@example.com"}',
  // ...
});

If Only send answers from current step is checked, only the answers from the current step will be sent.

Hide IP

  • If Hide IP is checked, the IP that Segment normally sends along in the context will be replaced with 0.0.0.0, per the

  • If Hide page context is checked, the values of path, referrer, urland search will be replaced in the page set in the context sent by segment.

If Send PII is checked, , such as the responder's email (when it is given that semantic label), will be sent along with the answers:

Need more guidance? Followto set up Segment.

🔌
Segment
identify
responder UUID
responder UUID
our guide
PII answers