Typeform Plugin documentation

Report an issue

Back to source list

Official

Typeform

This plugin is in preview.

The CloudQuery Typeform plugin pulls data from Typeform and loads it into any supported CloudQuery destination

Publisher

cloudquery

Repositorygithub.com

Latest version

v1.5.9

Type

Source

Platforms

Date Published

December 3, 2024

Price

Free

Documentation Tables Changelog Destinations

Overview

Overview #

This plugin is now deprecated and will be removed from CloudQuery Hub soon.

The CloudQuery Typeform plugin pulls data from Typeform and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more).

See tables for a list of resources supported.

Example Configuration #

This example syncs from Typeform to a Postgres destination. The (top level) source spec section is described in the Source Spec Reference.

kind: source
# Common source-plugin configuration
spec:
  name: typeform
  registry: docker
  path: docker.cloudquery.io/cloudquery/source-typeform:v1.5.9
  tables: ["typeform_forms"]
  destinations: ["postgresql"]
  # Typeform-specific configuration
  spec:
    # required
    access_token: "${TYPEFORM_ACCESS_TOKEN}"
    # optional, default: https://api.typeform.com, use https://api.eu.typeform.com for EU accounts
    # base_url: "https://api.typeform.com"
    # Optional, default: 100
    # concurrency: 100
    # Optional, default: 10000
    # queue_size: 10000

The Typeform plugin is distributed as a Docker image. This requires a Docker runtime to be installed on the same machine as the CloudQuery CLI, and a CLI version that supports the docker registry type (v3.12.0 and higher).

Authentication #

In order to fetch information from Typeform, cloudquery needs to authenticate using a personal access token for Typeform's APIs. Follow the instructions on the Typeform website and create a read-only token.

Configuration Reference #

This is the (nested) spec used by the Typeform source plugin:

access_token (string) (required)
Your personal access token from the Typeform Dashboard.
base_url (string) (optional) (default: https://api.typeform.com)
The base URL to fetch data from. Use https://api.eu.typeform.com if your account is stored in the EU.
concurrency (integer) (optional) (default: 100)
Maximum number of requests to perform concurrently.
queue_size (integer) (optional) (default: 10000)
Maximum number of items to have in the queue before waiting for an unfinished request to complete.

Running in a Containerized Environment #

To run the Typeform plugin in a containerized environment, see the Using CloudQuery Docker Registry Plugins Inside a Containerized Environment guide.