Integrate Typeform into the workflow. Can retrieve responses, download files, and get form insights. Can be used in trigger mode to trigger a workflow when a form is submitted. Requires API Key.
Retrieve form responses from Typeform
| Parameter | Type | Required | Description |
|---|
formId | string | Yes | Typeform form ID |
apiKey | string | Yes | Typeform Personal Access Token |
pageSize | number | No | Number of responses to retrieve (default: 25) |
since | string | No | Retrieve responses submitted after this date (ISO 8601 format) |
until | string | No | Retrieve responses submitted before this date (ISO 8601 format) |
completed | string | No | Filter by completion status (true/false) |
| Parameter | Type | Description |
|---|
total_items | number | Total number of responses |
page_count | number | Total number of pages available |
items | array | Array of response objects with response_id, submitted_at, answers, and metadata |
Download files uploaded in Typeform responses
| Parameter | Type | Required | Description |
|---|
formId | string | Yes | Typeform form ID |
responseId | string | Yes | Response ID containing the files |
fieldId | string | Yes | Unique ID of the file upload field |
filename | string | Yes | Filename of the uploaded file |
inline | boolean | No | Whether to request the file with inline Content-Disposition |
apiKey | string | Yes | Typeform Personal Access Token |
| Parameter | Type | Description |
|---|
fileUrl | string | Direct download URL for the uploaded file |
contentType | string | MIME type of the uploaded file |
filename | string | Original filename of the uploaded file |
Retrieve insights and analytics for Typeform forms
| Parameter | Type | Required | Description |
|---|
formId | string | Yes | Typeform form ID |
apiKey | string | Yes | Typeform Personal Access Token |
| Parameter | Type | Description |
|---|
fields | array | Analytics data for individual form fields |
form | object | Form-level analytics and performance data |
Retrieve a list of all forms in your Typeform account
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Typeform Personal Access Token |
search | string | No | Search query to filter forms by title |
page | number | No | Page number (default: 1) |
pageSize | number | No | Number of forms per page (default: 10, max: 200) |
workspaceId | string | No | Filter forms by workspace ID |
| Parameter | Type | Description |
|---|
total_items | number | Total number of forms in the account |
page_count | number | Total number of pages available |
items | array | Array of form objects with id, title, created_at, last_updated_at, settings, theme, and _links |
Retrieve complete details and structure of a specific form
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Typeform Personal Access Token |
formId | string | Yes | Form unique identifier |
| Parameter | Type | Description |
|---|
id | string | Form unique identifier |
title | string | Form title |
type | string | Form type (form, quiz, etc.) |
settings | object | Form settings including language, progress bar, etc. |
theme | object | Theme reference |
workspace | object | Workspace reference |
fields | array | Array of form fields/questions |
welcome_screens | array | Array of welcome screens |
thankyou_screens | array | Array of thank you screens |
_links | object | Related resource links including public form URL |
Create a new form with fields and settings
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Typeform Personal Access Token |
title | string | Yes | Form title |
type | string | No | Form type (default: "form"). Options: "form", "quiz" |
workspaceId | string | No | Workspace ID to create the form in |
fields | json | No | Array of field objects defining the form structure. Each field needs: type, title, and optional properties/validations |
settings | json | No | Form settings object (language, progress_bar, etc.) |
themeId | string | No | Theme ID to apply to the form |
| Parameter | Type | Description |
|---|
id | string | Created form unique identifier |
title | string | Form title |
type | string | Form type |
fields | array | Array of created form fields |
_links | object | Related resource links including public form URL |
Update an existing form using JSON Patch operations
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Typeform Personal Access Token |
formId | string | Yes | Form unique identifier to update |
operations | json | Yes | Array of JSON Patch operations (RFC 6902). Each operation needs: op (add/remove/replace), path, and value (for add/replace) |
| Parameter | Type | Description |
|---|
id | string | Updated form unique identifier |
title | string | Form title |
type | string | Form type |
settings | object | Form settings |
theme | object | Theme reference |
workspace | object | Workspace reference |
fields | array | Array of form fields |
welcome_screens | array | Array of welcome screens |
thankyou_screens | array | Array of thank you screens |
_links | object | Related resource links |
Permanently delete a form and all its responses
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | Typeform Personal Access Token |
formId | string | Yes | Form unique identifier to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the form was successfully deleted |
message | string | Deletion confirmation message |
Trigger workflow when a Typeform submission is received
| Parameter | Type | Description |
|---|
event_id | string | Unique identifier for this webhook event |
event_type | string | Type of event (always "form_response" for form submissions) |
form_id | string | Typeform form identifier |
token | string | Unique response/submission identifier |
submitted_at | string | ISO timestamp when the form was submitted |
landed_at | string | ISO timestamp when the user first landed on the form |
calculated.score | number | Calculated score value |
variables | array | Array of dynamic variables with key, type, and value |
hidden | json | Hidden fields passed to the form (e.g., UTM parameters) |
answers | array | Array of respondent answers (only includes answered questions). Each answer contains type, value, and field reference. |
definition.id | string | Form ID |
definition.title | string | Form title |
definition.fields | array | Array of form fields |
definition.endings | array | Array of form endings |
ending.id | string | Ending screen ID |
ending.ref | string | Ending screen reference |
raw | json | Complete original webhook payload from Typeform |
- Category:
tools
- Type:
typeform