You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/sources/typeform.md
+30-32Lines changed: 30 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,15 @@
1
1
# Typeform
2
2
3
-
This page guides you through the process of setting up the Typeform source connector.
3
+
This page contains the setup guide and reference information for the [Typeform](https://www.typeform.com/) source connector.
4
4
5
5
## Prerequisites
6
6
7
-
-[Typeform Account](https://www.typeform.com/)
8
-
- 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)
9
-
<!-- env:cloud -->
10
-
11
-
**For Airbyte Cloud:**
12
-
13
-
- OAuth
7
+
- A [Typeform](https://www.typeform.com/) account
8
+
<!-- env:cloud -->
9
+
- For Airbyte Cloud: OAuth authentication
14
10
<!-- /env:cloud -->
15
-
16
11
<!-- env:oss -->
17
-
18
-
**For Airbyte Open Source:**
19
-
20
-
- Personal Access Token (see [personal access token](https://www.typeform.com/developers/get-started/personal-access-token/))
12
+
- For Airbyte Open Source: A Typeform [personal access token](https://www.typeform.com/developers/get-started/personal-access-token/) with the following read scopes: `forms:read`, `responses:read`, `webhooks:read`, `workspaces:read`, `images:read`, and `themes:read`
21
13
<!-- /env:oss -->
22
14
23
15
## Setup guide
@@ -27,21 +19,24 @@ This page guides you through the process of setting up the Typeform source conne
27
19
<!-- env:oss -->
28
20
29
21
**For Airbyte Open Source:**
30
-
To get the API token for your application, follow these [steps](https://developer.typeform.com/get-started/personal-access-token/):
31
22
32
-
1. Log in to your account at Typeform.
33
-
2. In the upper-right corner, in the drop-down menu next to your profile photo, click **My Account**.
23
+
To generate a personal access token for your Typeform account:
24
+
25
+
1. Log in to your [Typeform](https://www.typeform.com/) account.
26
+
2. In the upper-left corner, in the drop-down menu next to your username, click **Account**.
34
27
3. In the left menu, click **Personal tokens**.
35
28
4. Click **Generate a new token**.
36
29
5. In the **Token name** field, type a name for the token to help you identify it.
37
-
6.Choose the scopes you need (API actions this token can perform). See [OAuth 2.0 scopes](https://www.typeform.com/developers/get-started/scopes/) for more details.
30
+
6.Select the following scopes: `forms:read`, `responses:read`, `webhooks:read`, `workspaces:read`, `images:read`, and `themes:read`. See [OAuth scopes](https://www.typeform.com/developers/get-started/scopes/) for details.
38
31
7. Click **Generate token**.
32
+
39
33
<!-- /env:oss -->
40
34
41
35
<!-- env:cloud -->
42
36
43
37
**For Airbyte Cloud:**
44
-
This step is not needed in Airbyte Cloud. Skip to the next step.
38
+
39
+
Skip this step. Airbyte Cloud uses OAuth to authenticate with Typeform.
45
40
46
41
<!-- /env:cloud -->
47
42
@@ -54,11 +49,11 @@ This step is not needed in Airbyte Cloud. Skip to the next step.
54
49
1.[Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
55
50
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ New Source**.
56
51
3. On the source setup page, select **Typeform** from the Source type dropdown and enter a name for this connector.
57
-
4. Click `Authenticate your Typeform account` by selecting Oauth or Personal Access Token for Authentication.
58
-
5.Log in and Authorize to the Typeform account.
59
-
6.**Start date (Optional)** - The date from which to start fetching Responses stream data, in the format `YYYY-MM-DDT00:00:00Z`. If not set, the Responses stream fetches data from one year ago.
60
-
7.**Form IDs (Optional)** - List of Form IDs to sync. If not specified, all forms in your account are synced.
61
-
8. Click **Set up source**.
52
+
4. Click **Authenticate your Typeform account** and complete the OAuth flow.
53
+
5.**Start date** (Optional) - The date from which you want to replicate data for the Responses stream, in the format `YYYY-MM-DDT00:00:00Z`. If not set, the connector fetches response data from one year before the current date.
54
+
6.**Form IDs** (Optional) - IDs of specific forms to sync. If not specified, the connector syncs all forms in your account. You can find form IDs in your form URLs on the **Share** panel. For example, in the URL `https://mysite.typeform.com/to/u6nXL7`, the form ID is `u6nXL7`.
55
+
7.Click **Set up source**.
56
+
62
57
<!-- /env:cloud -->
63
58
64
59
<!-- env:oss -->
@@ -67,15 +62,18 @@ This step is not needed in Airbyte Cloud. Skip to the next step.
67
62
68
63
1. Go to your local Airbyte instance.
69
64
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ New Source**.
70
-
3. On the Set up the source page, enter a name for the connector and select **Typeform** from the Source type dropdown.
71
-
4. Enter your **API Token** and optionally set a **Start Date**.
72
-
5. Click **Set up source**.
65
+
3. On the source setup page, enter a name for the connector and select **Typeform** from the Source type dropdown.
66
+
4. Enter your personal access token in the **API Token** field.
67
+
5.**Start date** (Optional) - The date from which you want to replicate data for the Responses stream, in the format `YYYY-MM-DDT00:00:00Z`. If not set, the connector fetches response data from one year before the current date.
68
+
6.**Form IDs** (Optional) - IDs of specific forms to sync. If not specified, the connector syncs all forms in your account. You can find form IDs in your form URLs on the **Share** panel. For example, in the URL `https://mysite.typeform.com/to/u6nXL7`, the form ID is `u6nXL7`.
| Webhooks | id | No |https://developer.typeform.com/webhooks/reference/retrieve-webhooks/|
@@ -85,14 +83,14 @@ This step is not needed in Airbyte Cloud. Skip to the next step.
85
83
86
84
## Performance considerations
87
85
88
-
Typeform API page size limit per source:
86
+
The Typeform API enforces a rate limit of 2 requests per second per account. The connector respects this limit automatically. For more information, see the [Typeform API rate limits documentation](https://developer.typeform.com/get-started/#rate-limits).
89
87
90
-
- Forms - 200
91
-
- Responses - 1000
88
+
Page size limits per stream:
92
89
93
-
The connector performs an additional API call to fetch all form IDs in your account using the [retrieve forms endpoint](https://developer.typeform.com/create/reference/retrieve-forms/).
90
+
- Forms: 200
91
+
- Responses: 1000
94
92
95
-
API rate limits \(2 requests per second\): [https://developer.typeform.com/get-started/\#rate-limits](https://developer.typeform.com/get-started/#rate-limits)
93
+
The connector makes an additional API call per sync to fetch the list of form IDs in your account using the [retrieve forms endpoint](https://developer.typeform.com/create/reference/retrieve-forms/).
0 commit comments