Typeform

Learn how to use Typeform with Composio

Overview

SLUG: TYPEFORM

Description

Build beautiful, interactive forms that people love to fill out. Collect data, accept payments, and integrate with your favorite tools.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to accounts:read,forms:read,forms:write,images:read,images:write,themes:read,themes:write,responses:read,responses:write,webhooks:read,webhooks:write,workspaces:read,workspaces:write,offline

Connecting to Typeform

Create an auth config

Use the dashboard to create an auth config for the Typeform toolkit. This allows you to connect multiple Typeform accounts to Composio for agents to use.

1

Select App

Navigate to Typeform.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Typeform Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4typeform_auth_config_id = "ac_YOUR_TYPEFORM_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Typeform: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, typeform_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Typeform toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Create Account Workspace

Description

Tool to create a new workspace in a specific Typeform account. Use when you need to create a workspace within a particular account using the account ID.

Action Parameters

account_id
stringRequired
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Form

Description

Tool to create a new Typeform form with customizable fields, logic, and settings. Use when you need to programmatically create a form with specific questions, welcome screens, thank you screens, and conditional logic.

Action Parameters

fields
logic
settings
thankyou_screens
theme
title
stringRequired
type
welcome_screens
workspace

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Image

Description

Tool to upload a new image to your Typeform account via base64 encoding or URL. Use when you need to add images for forms or presentations. Either 'image' (base64) or 'url' parameter must be provided.

Action Parameters

file_name
stringRequired
image
url

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create or Update Webhook

Description

Tool to create a new webhook or update an existing one for a specified Typeform. Use when you need to configure webhooks to receive form response notifications at a specified URL.

Action Parameters

enabled
booleanDefaults to True
event_types
form_id
stringRequired
secret
tag
stringRequired
url
stringRequired
verify_ssl

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Theme

Description

Tool to create a new custom theme in Typeform with colors, fonts, background, and layout settings. Use when you need to create a theme for branding and styling Typeform forms.

Action Parameters

background
colors
objectRequired
fields
objectRequired
font
stringRequired
has_transparent_button
name
rounded_corners

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Workspace

Description

Tool to create a new workspace in Typeform. Use when organizing forms into separate workspaces for teams or projects.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Form

Description

Tool to permanently delete a Typeform and all of its responses. Use when you need to remove a form completely from the account.

Action Parameters

form_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Image

Description

Tool to delete an image from your Typeform account. Use when you need to remove an image that is no longer needed. Returns a success status once the image has been deleted (204 No Content).

Action Parameters

image_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Responses

Description

Tool to delete specific responses from a Typeform by response IDs. Use when you need to remove response data from a form. Deletion is asynchronous - a 200 status means the deletion request was registered, not that deletion is complete. Maximum 1000 response IDs can be deleted per request.

Action Parameters

form_id
stringRequired
included_response_ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Theme

Description

Tool to delete a theme from your Typeform account. Use when you need to permanently remove a theme. This operation cannot be undone.

Action Parameters

theme_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Webhook

Description

Tool to delete a webhook configuration from a Typeform form. Use when you need to remove a webhook from a specific form. The operation returns 204 No Content on success and 404 if the webhook is not found.

Action Parameters

form_id
stringRequired
tag
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Workspace

Description

Tool to delete a workspace from your Typeform account. Use when you need to remove a workspace. Note: The default 'My Workspace' cannot be deleted, and workspaces containing forms cannot be deleted (will return an error).

Action Parameters

workspace_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get About Me

Description

Get information about the owner account in Typeform.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Response Files

Description

Tool to retrieve a compressed archive containing all files that respondents uploaded for a specified form. Use when you need to download all file uploads from a Typeform form as a ZIP archive.

Action Parameters

form_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Background By Size

Description

Tool to retrieve a background image by size from Typeform. Use when you need to get a background image in a specific size (default, tablet, mobile, or thumbnail). Images are scaled and cropped from top-left alignment to fill the screen properly.

Action Parameters

image_id
stringRequired
size
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Choice Image By Size

Description

Tool to retrieve a choice image by size from Typeform. Use when you need to download images used in picture_choice question options at specific sizes.

Action Parameters

image_id
stringRequired
size
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Form

Description

Tool to retrieve a specific form's complete configuration including fields, logic, settings, and theme. Use when you need to get detailed information about a Typeform form.

Action Parameters

form_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Form Messages

Description

Tool to retrieve custom messages for a Typeform including button labels, error messages, and UI text. Use when you need to get the current message configuration for a form.

Action Parameters

form_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Form Responses

Description

Tool to retrieve form responses from Typeform with filtering by date, pagination, search, and response type. Use when you need to get responses for a specific form including timestamps of when users landed on and submitted the form. Note: Recent responses may take up to 30 minutes to appear.

Action Parameters

after
answered_fields
before
excluded_response_ids
fields
form_id
stringRequired
included_response_ids
page_size
query
response_type
since
sort
until

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Image By Size

Description

Tool to retrieve an image in a specific size from Typeform. Use when you need to get a Typeform image optimized for different display contexts (default for desktop, mobile for mobile devices, or thumbnail for previews).

Action Parameters

image_id
stringRequired
size
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Theme

Description

Tool to retrieve a specific theme's configuration including colors, fonts, and layout settings. Use when you need to get the design settings of a Typeform theme.

Action Parameters

theme_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Webhook

Description

Tool to retrieve a single webhook by specifying both the form ID and webhook tag. Use when you need to get details about a specific webhook configuration.

Action Parameters

form_id
stringRequired
tag
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Workspace

Description

Tool to retrieve detailed information about a specific workspace including its name, forms, and team members. Use when you need to get workspace details or check member access.

Action Parameters

workspace_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Forms

Description

Tool to retrieve a list of all forms in your Typeform account with filtering, pagination, and sorting options. Use when you need to list, search, or browse forms across workspaces. Supports filtering by search terms, workspace, and sorting by creation or modification date.

Action Parameters

order_by
page
page_size
search
sort_by
workspace_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Images

Description

Tool to retrieve all images in your Typeform account in reverse-chronological order. Use when you need to list or browse available images.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Typeform Themes

Description

Tool to retrieve a paginated list of themes in your Typeform account. Use when you need to access available themes for form styling. Returns both public and private themes with their styling configurations.

Action Parameters

page
page_size

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Form Webhooks

Description

Tool to retrieve all webhooks associated with a specified typeform. Use when you need to view webhook configurations for a form. Returns webhook IDs, URLs, enabled status, event types, and timestamps.

Action Parameters

form_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Workspaces

Description

Tool to retrieve all workspaces in a Typeform account with their IDs, names, form counts, and members. Use when you need to list available workspaces or search for specific workspaces by name.

Action Parameters

page
page_size
search

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Patch Form

Description

Tool to partially update a Typeform using JSON Patch operations. Use when you need to modify specific fields without replacing the entire form. Supports updating title, settings, theme, workspace, and other form properties.

Action Parameters

form_id
stringRequired
operations
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Theme (Partial)

Description

Tool to partially update a Typeform theme by ID. Updates only the specified properties while leaving other theme settings unchanged. Each provided field must be complete (e.g., if updating colors, all color subfields must be provided). Cannot modify Typeform's public built-in themes.

Action Parameters

background
colors
fields
font
has_transparent_button
name
rounded_corners
screens
theme_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Form

Description

Tool to update an existing Typeform by completely replacing its configuration. PUT request overwrites the entire form - any fields not included will be deleted along with their response data. Always retrieve the form first using Get Form, modify the desired properties, then send the complete updated form definition.

Action Parameters

fields
form_id
stringRequired
hidden
logic
settings
thankyou_screens
theme
title
type
variables
welcome_screens
workspace

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Form Messages

Description

Tool to update custom messages for form UI elements like buttons, errors, and placeholders in Typeform. Use when you need to customize the text displayed to form respondents.

Action Parameters

block_shortText_placeholder
form_id
stringRequired
label_buttonHint_default
label_buttonNoAnswer_default
label_button_submit
label_error_required

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Theme

Description

Tool to update a theme's complete definition in Typeform. Use when you need to update all aspects of a theme including colors, fonts, and visual properties. This is a full update (PUT) operation that requires name, font, and colors to be provided. For partial updates, use PATCH instead.

Action Parameters

background
colors
objectRequired
fields
font
stringRequired
has_transparent_button
name
stringRequired
rounded_corners
screens
theme_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Workspace

Description

Tool to update a workspace's name or manage team member access (add/remove members) in Typeform. Use when you need to rename a workspace or modify its member list using JSON Patch operations.

Action Parameters

operations
arrayRequired
workspace_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Upload Video

Description

Initiate a video upload to Typeform by obtaining a signed upload URL. Use this action to prepare for uploading a video file to a specific form field. After receiving the upload_url, use it to upload the actual video file via a PUT request.

Action Parameters

field_id
stringRequired
form_id
stringRequired
language
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired