Typeform

This page guides you through the process of setting up the Typeform source connector.

Prerequisites

• Typeform Account

• Form IDs (Optional) - If you want to sync data for specific forms, you'll need to have the IDs of those forms. If you want to sync data for all forms in your account you don't need any IDs. Form IDs can be found in the URLs to the forms in Typeform Admin Panel (for example, for URL https://admin.typeform.com/form/12345/ a 12345 part would your Form ID)

  For Airbyte Cloud:

• OAuth

For Airbyte Open Source:

• Personal Access Token (see personal access token)

Setup guide

Step 1: Obtain an API token

For Airbyte Open Source: To get the API token for your application follow this steps

• Log in to your account at Typeform.
• In the upper-right corner, in the drop-down menu next to your profile photo, click My Account.
• In the left menu, click Personal tokens.
• Click Generate a new token.
• In the Token name field, type a name for the token to help you identify it.
• Choose needed scopes (API actions this token can perform - or permissions it has). See here for more details on scopes.
• Click Generate token.

For Airbyte Cloud: This step is not needed in Airbyte Cloud. Skip to the next step.

Step 2: Set up the source connector in Airbyte

For Airbyte Cloud:

1. Log into your Airbyte Cloud account.
2. In the left navigation bar, click Sources. In the top-right corner, click + New Source.
3. On the source setup page, select Typeform from the Source type dropdown and enter a name for this connector.
4. Click Authenticate your Typeform account by selecting Oauth or Personal Access Token for Authentication.
5. Log in and Authorize to the Typeform account.
6. Start date (Optional) - Date to start fetching Responses stream data from. If start date is not set, Responses stream will fetch data from a year ago from today.
7. Form IDs (Optional) - List of Form Ids to sync. If not passed - sync all account`s forms.
8. Click Set up source.

For Airbyte Open Source:

1. Go to local Airbyte page.
2. In the left navigation bar, click Sources. In the top-right corner, click + New Source.
3. On the Set up the source page, enter the name for the connector and select Typeform from the Source type dropdown.
4. Fill-in API Token and Start Date
5. click Set up source

Supported streams and sync modes

Stream	Key	Incremental	API Link
Forms	id	No	https://developer.typeform.com/create/reference/retrieve-form/
Responses	response_id	Yes	https://developer.typeform.com/responses/reference/retrieve-responses
Webhooks	id	No	https://developer.typeform.com/webhooks/reference/retrieve-webhooks/
Workspaces	id	No	https://developer.typeform.com/create/reference/retrieve-workspaces/
Images	id	No	https://developer.typeform.com/create/reference/retrieve-images-collection/
Themes	id	No	https://developer.typeform.com/create/reference/retrieve-themes/

Performance considerations

Typeform API page size limit per source:

• Forms - 200
• Responses - 1000

Connector performs additional API call to fetch all possible form ids on an account using retrieve forms endpoint

API rate limits (2 requests per second): https://developer.typeform.com/get-started/#rate-limits

Build instructions

Build your own connector image

This connector is built using our dynamic built process. The base image used to build it is defined within the metadata.yaml file under the connectorBuildOptions. The build logic is defined using Dagger here. It does not rely on a Dockerfile.

If you would like to patch our connector and build your own a simple approach would be:

1. Create your own Dockerfile based on the latest version of the connector image.

FROM airbyte/source-typeform:latest

COPY . ./airbyte/integration_code
RUN pip install ./airbyte/integration_code

# The entrypoint and default env vars are already set in the base image
# ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
# ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]

Please use this as an example. This is not optimized.

2. Build your image:

docker build -t airbyte/source-typeform:dev .
# Running the spec command against your patched connector
docker run airbyte/source-typeform:dev spec

Customizing our build process

When contributing on our connector you might need to customize the build process to add a system dependency or set an env var. You can customize our build process by adding a build_customization.py module to your connector. This module should contain a pre_connector_install and post_connector_install async function that will mutate the base image and the connector container respectively. It will be imported at runtime by our build process and the functions will be called if they exist.

Here is an example of a build_customization.py module:

from __future__ import annotations

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    # Feel free to check the dagger documentation for more information on the Container object and its methods.
    # https://dagger-io.readthedocs.io/en/sdk-python-v0.6.4/
    from dagger import Container


async def pre_connector_install(base_image_container: Container) -> Container:
    return await base_image_container.with_env_variable("MY_PRE_BUILD_ENV_VAR", "my_pre_build_env_var_value")

async def post_connector_install(connector_container: Container) -> Container:
    return await connector_container.with_env_variable("MY_POST_BUILD_ENV_VAR", "my_post_build_env_var_value")

Changelog

Version	Date	Pull Request	Subject
1.1.1	2023-10-13	31377	Use our base image and remove Dockerfile
1.1.0	2023-09-04	29916	Migrate to Low-Code Framework
1.0.0	2023-06-26	27240	Add OAuth support
0.3.0	2023-06-23	27653	Add form_id to records of responses stream
0.2.0	2023-06-17	27455	Add missing schema fields in forms, themes, images, workspaces, and responses streams
0.1.12	2023-02-21	22824	Specified date formatting in specification
0.1.11	2023-02-20	23248	Store cursor value as a string
0.1.10	2023-01-07	16125	Certification to Beta
0.1.9	2022-08-30	16125	Improve metadata.referer url parsing
0.1.8	2022-08-09	15435	Update Forms stream schema
0.1.7	2022-06-20	13935	Update Responses stream schema
0.1.6	2022-05-23	12280	Full Stream Coverage
0.1.4	2021-12-08	8425	Update title, description fields in spec
0.1.3	2021-12-07	8466	Change Check Connection Function Logic
0.1.2	2021-10-11	6571	Support pulling data from a select set of forms
0.1.1	2021-09-06	5799	Add missed choices field to responses schema
0.1.0	2021-07-10	4541	Initial release for Typeform API supporting Forms and Responses streams