Skip to main content

Fillout Data Source

The Fillout connector enables you to ingest form metadata and submission data from your Fillout account into Nexla data flows. Use this connector to pull form lists, individual submission records, or full submission histories for analysis, reporting, or downstream processing. Follow the instructions below to create a new data flow that ingests data from a Fillout source in Nexla.
fillout_api.png

Fillout

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Fillout connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Fillout account, and click Next; or, create a new Fillout credential for use in this flow.

  3. In Nexla, Fillout data sources can be created using pre-built endpoint templates, which expedite source setup for common Fillout API endpoints. Each template is designed specifically for the corresponding Fillout endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Fillout sources can also be configured manually, allowing you to ingest data from Fillout endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Fillout endpoints. Each template is designed specifically for the corresponding Fillout API endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

List Forms

Retrieves a paginated list of all forms in your Fillout account. Use this endpoint to discover available forms, build form inventories, or identify form IDs needed for other endpoints such as List Form Submissions.

  • No additional parameters are required for this endpoint. Nexla will automatically paginate through all pages of results using offset-based pagination, fetching up to 50 forms per page until all forms are retrieved.
  • Each returned record includes the form's unique identifier, display name, creation date, and other metadata describing the form's configuration and current status in your account.

The Form IDs returned by this endpoint are required when configuring the List Form Submissions, Get Form Metadata, and Fetch Submission by ID endpoints. Run this endpoint first if you do not already know the IDs of your target forms.

List Form Submissions

Returns a paginated list of all submissions for a specific form. Use this endpoint to ingest respondent data, build reporting pipelines, or sync form responses into a data warehouse or downstream system.

  • Enter the unique identifier of the form whose submissions you want to retrieve in the Form ID field. This value is required.

    • Form IDs can be found by using the List Forms endpoint, or by opening the form in the Fillout editor at build.fillout.com and copying the ID from the URL or form settings.
  • Nexla will automatically paginate through all submission pages using offset-based pagination, retrieving up to 150 submissions per page until the complete submission history has been fetched.
  • Each record in the resulting Nexset represents one form submission and includes all question-response pairs, submission timestamps, respondent metadata, and any URL parameters captured at the time of submission.

Fillout's API rate limit is 5 requests per second per API key. For forms with very large submission histories, Nexla's paginated ingestion will stay within this limit. If you need to schedule frequent syncs, consider using a reasonable cron interval to avoid exhausting your rate allowance.

Get Form Metadata

Retrieves metadata for a single form, including all question definitions, field IDs, field types, and form settings. Use this endpoint for schema discovery before building a pipeline that reads or writes submission data, or when you need to understand a form's structure for data mapping purposes.

  • Enter the unique identifier of the form in the Form ID field. This value is required.

    • Form IDs are available from the List Forms endpoint or from the Fillout form editor URL at build.fillout.com.
  • The response is returned as a single record containing the form's complete structural definition, including question field IDs and types. These field IDs are required when creating or importing submissions via the Create Submissions destination endpoint.

This endpoint is particularly valuable when preparing to write data back into Fillout. Field IDs returned here must be used as keys in submission payloads to ensure responses are mapped to the correct form questions.

Fetch Submission by ID

Fetches a single form submission by its unique submission ID. Use this endpoint for point lookups, change-detection workflows, or when you need to enrich a downstream record with the full detail of a specific submission without re-ingesting the entire submission history.

  • Enter the unique identifier of the form in the Form ID field. This value is required.

    • Form IDs can be retrieved from the List Forms endpoint or from the Fillout form editor.

  • Enter the unique identifier of the submission in the Submission ID field. This value is required.

    • Submission IDs are included in the records returned by the List Form Submissions endpoint.
  • The response is returned as a single record containing all response data for that submission, including question-answer pairs, timestamps, and any captured metadata.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Fillout data sources can be manually configured to ingest data from any valid Fillout API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Fillout sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters not exposed by the standard templates.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Fillout API from the Method pulldown menu. The most common methods for Fillout source endpoints are:

    • GET: For retrieving forms, submissions, and form metadata

API Endpoint URL​

  1. Enter the URL of the Fillout API endpoint from which this source will fetch data in the Set API URL field. The Fillout REST API base URL is https://api.fillout.com/v1/api. Complete endpoint URL examples include:
    • List all forms: https://api.fillout.com/v1/api/forms
    • List submissions for a form: https://api.fillout.com/v1/api/forms/{'{formId}'}/submissions
    • Get form metadata: https://api.fillout.com/v1/api/forms/{'{formId}'}
    • Get a single submission: https://api.fillout.com/v1/api/forms/{'{formId}'}/submissions/{'{submissionId}'}

Replace {'{formId}'} and {'{submissionId}'} with the actual IDs for your target form and submission. You can retrieve Form IDs by first configuring a source using the List Forms template endpoint.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

The Fillout submissions endpoint supports afterDate and beforeDate query parameters that accept ISO 8601 datetime strings. Date/time macros are particularly useful for scheduling incremental ingestion of new submissions since the last run.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when Form IDs or Submission IDs are stored in another Nexla data source and you want to dynamically construct Fillout API requests based on those values.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the Fillout API endpoint is needed, you can designate the part of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response.

For example, the Fillout List Form Submissions endpoint wraps responses in a responses array alongside total count and pagination metadata. By specifying the path $.responses[*], you instruct Nexla to treat each element of the array as an individual submission record.

Path to Data is important when Fillout API responses have nested structures. Common JSON path values for Fillout endpoints include $[*] for list-of-forms responses and $.responses[*] for submission list responses.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.responses[*] to access the submissions array within a Fillout responses object).
    Path to Data Example:

    For the List Form Submissions endpoint, the Fillout API returns a JSON object with a top-level responses array that contains individual submission records. Enter $.responses[*] as the path to instruct Nexla to treat each element in that array as a separate record.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record.

For example, the Fillout List Form Submissions endpoint returns a totalResponses count and pageCount alongside the responses array. If you have specified $.responses[*] as the path to data, you can optionally capture this pagination metadata and attach it as context to each submission record.

Metadata paths are particularly useful for preserving API response context like total response counts or pagination information that applies to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). This may be needed for specific Fillout API features that require additional header parameters.

    You do not need to include the Authorization header here — it is automatically set by the Fillout credential you configured. Common headers like Authorization and Content-Type are handled automatically by Nexla based on your credential configuration.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Fillout data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.