Skip to main content

Typeform

This page contains the setup guide and reference information for the Typeform source connector.

Prerequisites​

  • For Calabi Connect: OAuth authentication
  • For Calabi Connect: A Typeform personal access token with the following read scopes: forms:read, responses:read, webhooks:read, workspaces:read, images:read, and themes:read

Setup guide​

Step 1: Obtain an API token​

For Calabi Connect:

To generate a personal access token for your Typeform account:

  1. Log in to your Typeform account.
  2. In the upper-left corner, in the drop-down menu next to your username, click Account.
  3. In the left menu, click Personal tokens.
  4. Click Generate a new token.
  5. In the Token name field, type a name for the token to help you identify it.
  6. Select the following scopes: forms:read, responses:read, webhooks:read, workspaces:read, images:read, and themes:read. See OAuth scopes for details.
  7. Click Generate token.

For Calabi Connect:

Skip this step. Calabi Connect uses OAuth to authenticate with Typeform.

Step 2: Set up the source connector in Calabi Connect​

For Calabi Connect:

  1. Log into your Calabi Connect 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 and complete the OAuth flow.
  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.
  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.
  7. Click Set up source.

For Calabi Connect:

  1. Go to your local Calabi Connect instance.
  2. In the left navigation bar, click Sources. In the top-right corner, click + New Source.
  3. On the source setup page, enter a name for the connector and select Typeform from the Source type dropdown.
  4. Enter your personal access token in the API Token field.
  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.
  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.
  7. Click Set up source.

Supported streams and sync modes​

StreamKeyIncrementalAPI Link
FormsidNohttps://developer.typeform.com/create/reference/retrieve-form/
Responsesresponse_idYeshttps://developer.typeform.com/responses/reference/retrieve-responses
WebhooksidNohttps://developer.typeform.com/webhooks/reference/retrieve-webhooks/
WorkspacesidNohttps://developer.typeform.com/create/reference/retrieve-workspaces/
ImagesidNohttps://developer.typeform.com/create/reference/retrieve-images-collection/
ThemesidNohttps://developer.typeform.com/create/reference/retrieve-themes/

Limitations​

This connector uses the Typeform US API endpoint (api.typeform.com). If your Typeform account stores responses in the EU Data Center, the Responses stream returns empty results. The Forms, Webhooks, Workspaces, Images, and Themes streams work regardless of data center region.

Performance considerations​

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.

Page size limits per stream:

  • Forms: 200
  • Responses: 1000
  • Workspaces: 200
  • Images: 200
  • Themes: 200

The Forms, Responses, and Webhooks streams make separate API calls for each form in your account. The connector first fetches the list of form IDs using the retrieve forms endpoint, then queries each form individually. If you have many forms, consider using the Form IDs configuration option to limit the sync to only the forms you need.