Typeform Connector

Typeform is an online form builder that enables users to create interactive and engaging surveys, forms, and quizzes.

Use the component to deploy forms and manage the responses in real time.

API Documentation

The component was built using the Typeform API References

Connections

OAuth 2.0

This connection allows you to authenticate with Typeform using OAuth 2.0.

To Generate an OAuth App:

1. Log in to your account at Typeform.
2. In the upper-left corner, click icon drop-down menu next to your organization name.
3. Under Organization section, click Developer Apps.
4. Click Register a new app.
5. In the App Name field, type the name for your new app.
6. In the App website field, type the complete URL for your app's homepage.
7. In the Redirect URI(s) field, enter https://oauth2.integrations.zenqms.com/callback
8. Click Register app.
9. Enter the following into the connection configuration of your integration
   1. Scopes (Recommended): offline accounts:read forms:write forms:read images:write images:write images:read themes:write themes:read responses:read responses:write webhooks:read webhooks:write workspaces:read workspaces:write
   2. Client ID
   3. Client Secret

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

Input	Comments	Default
Scopes	A comma-delimited set of one or more scopes to get the user's permission to access. Refer to https://www.typeform.com/developers/get-started/scopes/	offline accounts:read forms:write forms:read images:write images:write images:read themes:write themes:read responses:read responses:write webhooks:read webhooks:write workspaces:read workspaces:write
Client ID
Client Secret

Personal Token

Personal Token for Typeform

To Generate a Personal Access Token:

1. Log in to your account at Typeform.
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 or here.
4. Click Generate a new token.
5. In the Token name field, type a name for the token to help you identify it.
6. Choose needed scopes (API actions this token can perform - or permissions it has). See here for more details on scopes.
7. Click Generate token.
8. Enter the token value into the Personal Token field of the connection in your integration.

Input	Comments	Default
Personal Token	Personal Token for Typeform

Triggers

Typeform Webhook Trigger

Get notified when a project is created, updated, or deleted in a workspace.

Input	Comments	Default
Connection
Form Id	Unique ID for the form.
Secret	Will be used to sign the webhook payload with HMAC SHA256, so that you can verify that it came from Typeform.
Form Response	True if you want to send full responses to the webhook. Otherwise, false.
Form Response Partial	True if you want to send partial responses to the webhook. Otherwise, false.

Actions

Create Account Workspace

Create a workspace in a specific account.

Input	Comments	Default
Account Id	The unique identifier of the item to retrieve.
Workspace Name	The name of the workspace account to create.
Connection

Create Form

Create a form

Input	Comments	Default
Title	Title to use for the typeform.
Type	Type of the form.
Theme	URL of the workspace to use for the typeform. If you don't specify a URL for the workspace, Typeform saves the form in the default workspace.
Workspace URL	URL of the workspace to use for the typeform. If you don't specify a URL for the workspace, Typeform saves the form in the default workspace.
CUI Settings	The CUI settings for the form.
Fields	The fields for the form.
Hidden	The hidden fields for the form.
Logic	The logic for the form.
Settings	The settings for the form.
Thank You Screens	The thank you screens for the form.
Variables	The variables for the form.
Welcome Screens	The welcome screens for the form.
Connection

Create or Update Webhook

Create or Update a Webhook

Input	Comments	Default
Form Id	Unique ID for the form.
Tag	Unique name you want to use for the webhook.
Secret	Will be used to sign the webhook payload with HMAC SHA256, so that you can verify that it came from Typeform.
URL	Webhook URL.
Enabled	True if you want to send responses to the webhook immediately. Otherwise, false.	true
Form Response	True if you want to send full responses to the webhook. Otherwise, false.
Form Response Partial	True if you want to send partial responses to the webhook. Otherwise, false.
Connection

Create Workspace

Create a workspace.

Input	Comments	Default
Workspace Name	The name of the workspace.
Connection

Delete Form

Delete a form.

Input	Comments	Default
Form Id	Unique ID for the form.
Connection

Delete Instance Webhooks

Delete all webhooks from a form for the instance url provided.

Input	Comments	Default
Form Id	Unique ID for the form.
Instance URL	The instance URL to delete all webhooks from, if not provided, all webhooks from the current flow will be deleted.
Connection

Delete Response

Delete responses to a form.

Input	Comments	Default
Form Id	Unique ID for the form.
Included Response Ids	Comma-separated list of response_id values of the responses to delete. You can list up to 1000 tokens and choose to do so either in the request URL, or in its body.
Connection

Delete Webhook

Delete a webhook.

Input	Comments	Default
Form Id	Unique ID for the form.
Tag	Unique name you want to use for the webhook.
Connection

Delete Workspace

Delete a workspace.

Input	Comments	Default
Workspace Id	The workspace Id to delete.
Connection

Get All Response Files

Download a zip archive containing all files uploaded by respondents for the specified form ID.

Input	Comments	Default
Form Id	Unique ID for the form.
Connection

Get File from Response

Download an uploaded file knowing its form, response, field and name.

Input	Comments	Default
Form Id	Unique ID for the form.
Response Id	Unique ID for the response.
Field Id	Unique ID for the file upload field
Filename	Filename for the uploaded file
Connection

Get Form

Retrieve a form.

Input	Comments	Default
Form Id	Unique ID for the form.
Connection

Get Webhook

Retrieve a single webhook.

Input	Comments	Default
Form Id	Unique ID for the form.
Tag	Unique name you want to use for the webhook.
Connection

Get Workspace

Retrieve a workspace.

Input	Comments	Default
Workspace Id	The workspace Id to retrieve.
Connection

List Account Workspaces

Retrieve all workspaces you have access to within the specific account.

Input	Comments	Default
Connection
Account Id	The unique identifier of the item to retrieve.
Fetch All	If true, it will fetch all the records ignoring the rest of the parameters.	false
Page	The page of results to retrieve.
Page Size	Number of results to retrieve per page. Default is 10. Maximum is 200.
Search	Returns items that contain the specified string.

List Forms

Retrieves a list of JSON descriptions for all forms in your Typeform account (public and private).

Input	Comments	Default
Connection
Fetch All	If true, it will fetch all the records ignoring the rest of the parameters.	false
Page	The page of results to retrieve.
Page Size	Number of results to retrieve per page. Default is 10. Maximum is 200.
Search	Returns items that contain the specified string.
Workspace Id	Retrieve typeforms for the specified workspace.
Sort By	Field to sort the results by.
Order By	Order type.

List Responses

Returns form responses and date and time of form landing and submission.

Input	Comments	Default
Form Id	Unique ID for the form.
Fetch All	If true, it will fetch all the records ignoring the rest of the parameters.	false
Page	The page of results to retrieve.
Page Size	Number of results to retrieve per page. Default is 10. Maximum is 200.
Search	Returns items that contain the specified string.
Custom Query Params	Custom fields filter
Connection

List Webhooks

Retrieve all webhooks for the specified Typeform.

Input	Comments	Default
Form Id	Unique ID for the form.
Connection

List Workspaces

Retrieve all workspaces the user has access to.

Input	Comments	Default
Connection
Fetch All	If true, it will fetch all the records ignoring the rest of the parameters.	false
Page	The page of results to retrieve.
Page Size	Number of results to retrieve per page. Default is 10. Maximum is 200.
Search	Returns items that contain the specified string.

Raw Request

Send raw HTTP request to Typeform API

Input	Comments	Default
Connection
URL	Input the path only (/forms), The base URL is already included (https://api.typeform.com). For example, to connect to https://api.typeform.com/api/v3/forms, only /forms is entered in this field. e.g. /forms
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
File Data	File Data to be sent as a multipart form upload.
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Update Form

Update a form.

Input	Comments	Default
Form Id	Unique ID for the form.
Operations	Operations to perform on the data.
Connection

Update Workspace

Update a workspace.

Input	Comments	Default
Workspace Id	The workspace Id to update.
Operations	Operations to perform on the data.
Connection