Typeform

Comprehensive guide to Typeform integration in StackAI, including available actions, input and output details, and practical usage examples.

What is Typeform?

Typeform is an online platform that allows you to create interactive forms, surveys, and quizzes. Integrating Typeform with StackAI enables you to automate workflows, collect responses, and manage form data seamlessly within your AI-powered processes.

How to use it?

To use Typeform in StackAI, connect your Typeform account using a valid connection ID. Once connected, you can trigger actions such as retrieving forms, collecting responses, or managing form data. Each action requires specific inputs and configurations, which you provide in the workflow builder.

Establishing A Connection

1. Click “New Connection” and enter a name to identify it later.

2. You’ll be redirected to the Typeform login page.

3. Log in to your Typeform account.

4. Accept the required permissions. You’ll be redirected back to StackAI.

5. In the dropdown, select your newly created connection.

6. Click “Test” to verify that the connection is healthy.

Action Summary Table

Action Name	Description	Input
retrieve_account_workspaces	Retrieve all workspaces in your Typeform account	Account Id, Search, Page, Page Size
retrieve_forms	Retrieve all forms in your Typeform account	Search, Page, Page Size, Workspace Id
delete_form	Delete a specific form	Form Id
retrieve_form	Retrieve a single form's details	Form Id
update_form_patch	Update a form (partial update)	Form Id
update_form	Update a form (full update)	Form Id
retrieve_custom_form_messages	Retrieve custom messages for a form	Form Id
update_custom_messages	Update custom messages for a form	Form Id
delete_responses	Delete responses from a form	Form Id, Included Response Ids
retrieve_responses	Retrieve responses for a form	Form Id, Page Size, Since, Until, After, Before, Included Response Ids, Excluded Response Ids, Completed, Sort, Query, Fields, Answered Fields
retrieve_response_file	Download all responses for a form as a file	Form Id, Response Id, Field Id, Filename, Inline
retrieve_webhooks	Retrieve all webhooks for a form	Form Id
delete_webhook	Delete a webhook from a form	Form Id, Tag
retrieve_single_webhook	Retrieve a single webhook's details	Form Id, Tag
retrieve_images_collection	Retrieve all images in your Typeform account	-
delete_image	Delete an image from your Typeform account	Image Id
retrieve_image	Retrieve a single image's details	Image Id
retrieve_background_by_size	Retrieve a background image by size	Image Id, Size
retrieve_choice_image_by_size	Retrieve a choice image by size	Image Id, Size
retrieve_image_by_size	Retrieve an image by size	Image Id, Size
retrieve_form_insights	Retrieve insights for a form	Form Id
retrieve_your_own_user	Retrieve your own user details	-
rtbf_delete_responses	Delete responses for right to be forgotten (GDPR)	Account Id
retrieve_themes	Retrieve all themes in your Typeform account	Page, Page Size
delete_theme	Delete a theme from your Typeform account	Theme Id
retrieve_theme	Retrieve a single theme's details	Theme Id
update_theme	Update a theme	Theme Id
retrieve_workspaces	Retrieve all workspaces	Search, Page, Page Size
delete_workspace	Delete a workspace	Workspace Id
retrieve_workspace	Retrieve a single workspace's details	Workspace Id
update_workspace	Update a workspace	Workspace Id

Output

1. Status Code (integer)

   • This is the HTTP status code returned by the Typeform API after attempting to delete the form.

   • Common values:

     • 200: Success (form deleted)

     • 204: Success (no content, form deleted)

     • 404: Not found (form does not exist)

     • 401/403: Unauthorized/Forbidden (invalid credentials or permissions)

     • 500: Internal server error

2. Headers (dict)

   • This is a dictionary containing the HTTP response headers from the Typeform API.

   • Headers may include metadata such as:

     • Content-Type: The format of the response (e.g., application/json)

     • Date: The time the response was sent

     • Rate limit information: How many API calls you have left, etc.

3. Body (object)

   • This is the main content of the response, usually in JSON format.

   • For a successful delete, the body may be empty or contain a confirmation message.

   • For errors, the body will typically include details such as:

     • error: A short error code or message

     • description: A human-readable explanation of the error

Advanced Settings

• Retry on Failure: Enable retrying when the node execution fails

• Fallback Branch: Create a separate branch that executes when this node fails, allowing you to handle errors gracefullyCreate a separate branch that executes when this node fails, allowing you to handle errors gracefully