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
  • Posting Frequency
  • Security
  • Shape of the data
  • Testing webhooks
  • Setting up the Webhook Integration
  • Adding multiple Webhook instances

Was this helpful?

  1. Handling data
  2. Integration reference

Webhooks

PreviousTrustedFormNextZapier

Last updated 2 months ago

Was this helpful?

The most robust way to receive data during a flow's progress and completion is to set up an endpoint for ingesting webhooks. Formsort sends data to this endpoint after a step is completed by the responder.

Youโ€™ve reached our technical documentation. You may wish to visit our .

Posting Frequency

The frequency of sending data to the webhook can be configured as:

  • On Finalize: only at the end of the flow.

  • On Savepoint: after each step marked as save point, and at the end of the flow.

  • Every step: at the end of each step (when the responder advances using the Next button), and at the end of the flow.

  • Abandoned: when the responder abandons the flow after a period of inactivity, and at the end of the flow. Formsort recommends using this setting to reduce the load on the webhook.

Security

Formsort backend system will exclusively send webhook requests from the static IP 18.217.92.196.

Shape of the data

The webhook is a POST of JSON data in the following shape:

{
  ...answers,
  "flow_label": string,
  "variant_label": string,
  "variant_uuid": string,
  "finalized": boolean,
  "created_at": string
}

If you'd like the responder uuid to be included, you can give it an alias in the webhook configuration.

It's possible to change the shape of the data, for example to nest the answers under their own key, or put them into an array.

The finalizedfield indicates that the flow has been completed. The value of finalized will betrue when any of the following conditions are met:

  1. All questions in the final step of the form have been answered, submitted, and the user has clicked Next.

  2. User arrives at a step with the Is finalizing? option toggled on.

  3. The user is redirected in the current tab.

Testing webhooks

You can send a test webhook with dummy data for a variant with the Send test webhook button, or just inspect a sample webhook body with the View webhook payload button.

Setting up the Webhook Integration

Formsort makes it easy to get a webhook integration set up. By adding the Webhook URL, Formsort will immediately start sending answer data to the webhook destination at the frequency you've selected.

First, head to the webhook integration menu in your flow

All integrations, including webhooks, can be customized on a per-flow basis.

Adding multiple Webhook instances

To enable multiple destinations, first complete setup for an initial destination (Destination 1). Then, click the "+ Add destination" button. Up to 3 instances can be added.

Once you've finished configuring all instances of your Webhook integration, be sure to Save with the button in the top right corner.

Change the webhook posting frequency to the desired frequency. Refer to for a more in-depth explanation. Once your posting frequency is selected, the menu will open and you can add your Webhook URL.

Add any other configuration options you require (covered in this chapter). If you'd like to add more than one webhook configuration, proceed to . Otherwise, Save the configuration with the Save button in the top right corner. Once saved, Formsort will begin sending the answers it collects from deployed flows to the webhook destination.

If you have deployed flows previous to integrating with your webhook, it is advisable to re- those flows.

There is an option to send answer payloads to multiple Webhook destinations. This is useful if you'd like to share your data across multiple endpoints, or have payloads that are sent at different go to different destinations.

If you have deployed flows previous to integrating with or updating your webhook, it is advisable to re- those flows.

๐Ÿ’พ
features page on webhooks
deploy
submission frequencies
deploy
Posting Frequency
Adding multiple Webhook instances
The Webhook integration menu
Adding a Webhook Posting Frequency will open the menu