Typeform
This page guides you through the process of setting up the Typeform source connector.
Prerequisites
-
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/a12345part 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:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click + New Source.
- On the source setup page, select Typeform from the Source type dropdown and enter a name for this connector.
- Click
Authenticate your Typeform accountby selecting Oauth or Personal Access Token for Authentication. - Log in and Authorize to the Typeform account.
- 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.
- Form IDs (Optional) - List of Form Ids to sync. If not passed - sync all account`s forms.
- Click Set up source.
For Airbyte Open Source:
- Go to local Airbyte page.
- In the left navigation bar, click Sources. In the top-right corner, click + New Source.
- On the Set up the source page, enter the name for the connector and select Typeform from the Source type dropdown.
- Fill-in API Token and Start Date
- 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
Reference
Config fields reference
Field
Type
Property name
object
credentials
string
start_date
array<string>
form_ids
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 1.2.8 | 2024-05-02 | 36667 | Schema descriptions |
| 1.2.7 | 2024-04-30 | 37599 | Changed last_records to last_record |
| 1.2.6 | 2024-03-13 | 36164 | Unpin CDK version |
| 1.2.5 | 2024-02-12 | 35152 | Manage dependencies with Poetry. |
| 1.2.4 | 2024-01-24 | 34484 | Fix pagination stop condition |
| 1.2.3 | 2024-01-11 | 34145 | prepare for airbyte-lib |
| 1.2.2 | 2023-12-12 | 33345 | Fix single use refresh token authentication |
| 1.2.1 | 2023-12-04 | 32775 | Add 499 status code handling |
| 1.2.0 | 2023-11-29 | 32745 | Add response_type field to responses schema |
| 1.1.2 | 2023-10-27 | 31914 | Fix pagination for stream Responses |
| 1.1.1 | 2023-10-19 | 31599 | Base image migration: remove Dockerfile and use the python-connector-base image |
| 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 |