Typeform snapshot

A high-level look at Stitch's Typeform integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release Status

Open Beta

Supported By

Singer Community

Stitch Plan

Free

Singer GitHub Repository

Typeform Repository

DATA SELECTION
Table Selection

Supported

Column Selection

Supported

REPLICATION SETTINGS
Anchor Scheduling

Supported

Table-level Reset

Unsupported

Configurable Replication Methods

Unsupported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Typeform

Step 1: Generate a Typeform API token

  1. Sign into your Typeform account.
  2. Click the user menu (your icon) in the top right corner of the page.
  3. In the menu, click My Account.
  4. On the page that displays, click Personal tokens on the left side of the page.
  5. The Personal tokens page will display. Click the Generate a new token button.
  6. Enter a Token name. For example: Stitch
  7. In the Scopes section, click Custom scopes.
  8. In the list that displays, select the Read option for the following permissions:
    • Accounts
    • Forms
    • Images
    • Responses
    • Themes
    • Workspaces
  9. Click Generate token.
  10. A window with the token will display. Copy the token somewhere handy, as you’ll need it to complete the setup. Note: Typeform will only display the token once. If you close this window, you’ll need to re-generate the token.

Step 2: Retrieve Typeform form IDs

Stitch’s Typeform will retrieve data only for the forms you specify in the Integration Settings page. In this step, you’ll retrieve the IDs of the forms you want Stitch to replicate.

  1. In your Typeform account, navigate back to your workspaces.
  2. On the workspace page, click on a form you want to include in Stitch. This should open the form’s edit page.
  3. Look at the URL of the page in your browser. It should be similar to https://admin.typeform.com/form/FrZ6iD/create. The string between form/ and /create is the form’s ID. In this example, the ID is FrZ6iD.
  4. Copy the form ID somewhere handy.
  5. Repeat steps 2-4 for every form you want to include in Stitch.

Step 3: Add Typeform as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Typeform icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Typeform” would create a schema called stitch_typeform in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the API Token field, paste the Typeform API token you generated in Step 1.
  6. In the Forms field, enter a comma-separated list of the form IDs you retrieved in Step 2. For example:
    • Single form: FrZ6iD
    • Multiple forms: FrZ6iD,f8nzFM
  7. In the Incremental Range dropdown, select the type of data aggregation you want Stitch to use:

    • Daily: Data will be aggregated by day.
    • Hourly: Data will be aggregated by hour.

Step 4: Define the historical sync

The Sync Historical Data setting will define the starting date for your Typeform integration. This means that:

  • For tables using Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
  • For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Typeform’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 5: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Stitch offers two methods of creating a replication schedule:

  • Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
  • Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:

    • A Replication Frequency of at least one hour is required to use anchor scheduling.
    • An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 6: Set tables and columns to replicate

To complete the setup, you’ll need to select the tables and columns you want to replicate to your data warehouse.

Check out the Schema section to learn more about the available tables in Typeform and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A green checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

Initial and historical replication jobs

After you finish setting up Typeform, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


Typeform table schemas

Replication Method :

Key-based Incremental

Replication Key :

landing_id

Primary Key :

landing_id : question_id

API endpoint :

Retrieve responses

The answers table contains info about the answers submitted for the forms specified in the Integration Settings page.

landing_id
STRING

The ID for the form landing.

Reference:

question_id
STRING

The question ID.

Reference:

answer
STRING

data_type
STRING

The field type of the question. Possible values are:

  • choice
  • choices
  • date
  • email
  • url
  • file_url
  • number
  • boolean
  • text
  • payment

ref
STRING

type
STRING


Replication Method :

Key-based Incremental

Replication Key :

submitted_at

Primary Key :

landing_id

API endpoint :

Retrieve responses

The landings table contains info about form landings. Depending on the Incremental Range setting defined in the Integration Settings page, data may be aggregated on a daily or hourly basis.

landing_id
STRING

The landing ID.

Reference:

submitted_at
DATE-TIME

The time that the form response was submitted in ISO 8601 format, UTC time.

browser
STRING

The browser used in the landing.

hidden
STRING

landed_at
DATE-TIME

The time of the form landing in ISO 8601 format, UTC time.

network_id
STRING

The IP address of the client.

platform
STRING

The platform used in the landing, derived from user_agent.

referer
STRING

If applicable, the referrer used in the landing.

token
STRING

user_agent
STRING

The user agent used in the landing.


Replication Method :

Full Table

Primary Key :

form_id : question_id

API endpoint :

Retrieve form

The questions table contains a list of question titles and IDs that can be used to link to answers.

form_id
STRING

The form ID.

question_id
STRING

The question ID.

Reference:

ref
STRING

The readable name used to reference the question field.

title
STRING

The unique name assigned to the field on the form.



Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.