Typeform Component

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

Component key: typeform

Description

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

To Generate an OAuth App:

Log in to your account at Typeform.
In the upper-left corner, click icon drop-down menu next to your organization name.
Under Organization section, click Developer Apps.
Click Register a new app.
In the App Name field, type the name for your new app.
In the App website field, type the complete URL for your app's homepage.
In the Redirect URI(s) field, enter https://oauth2.prismatic.io/callback for US based integrations
1. For integrations outside the US refer to this guide to find your region’s Callback URL
Click Register app.
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

Input	Default	Notes
Authorize URL string / Required Hidden Field authorizeUrl	https://api.typeform.com/oauth/authorize	The OAuth 2.0 Authorization URL for Typeform
Client ID string / Required clientId
Client Secret password / Required clientSecret
Scopes string / Required 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	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/
Token URL string / Required Hidden Field tokenUrl	https://api.typeform.com/oauth/token	The OAuth 2.0 Token URL for Typeform

Personal Token

To Generate a Personal Access Token:

Log in to your account at Typeform.
In the upper-left corner, in the drop-down menu next to your username, click Account.
In the left menu, click Personal tokens or here.
Click Generate a new token.
In the Token name field, type a name for the token to help you identify it.
Choose needed scopes (API actions this token can perform - or permissions it has). See here for more details on scopes.
Click Generate token.
Enter the token value into the Personal Token field of the connection in your integration.

Input	Notes
Personal Token password / Required personalToken	Personal Token for Typeform

Triggers

Typeform Webhook Trigger

Get notified when a project is created, updated, or deleted in a workspace. | key: formTrigger

Input	Notes	Example
Connection connection / Required connection
Form Id string / Required formId	Unique ID for the form.	u6nXL7
Form Response string formResponse	True if you want to send full responses to the webhook. Otherwise, false.
Form Response Partial string formResponsePartial	True if you want to send partial responses to the webhook. Otherwise, false.
Secret string / Required secret	Will be used to sign the webhook payload with HMAC SHA256, so that you can verify that it came from Typeform.	phoenix

Data Sources

Select Account Workspaces

Allow a user to select one of their account workspaces | key: selectAccountWorkspaces | type: picklist

Input	Notes	Example
Account Id string / Required accountId	The unique identifier of the item to retrieve.	123
Connection connection / Required connection

Example Payload for Select Account Workspaces

{
  "result": [
    {
      "label": "My Workspace",
      "key": "a1b2c3"
    },
    {
      "label": "My Second Workspace",
      "key": "a1b2c323"
    }
  ]
}

Select Form

Allow a user to select one of their forms | key: selectForm | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Select Form

{
  "result": [
    {
      "label": "Form title",
      "key": "PVdw1syM"
    },
    {
      "label": "My Other Form",
      "key": "PVdw1syMS"
    }
  ]
}

Select Workspaces

Allow a user to select one of their workspaces | key: selectWorkspaces | type: picklist

Input	Notes
Connection connection / Required connection

Example Payload for Select Workspaces

{
  "result": [
    {
      "label": "My Workspace",
      "key": "a1b2c3"
    },
    {
      "label": "My Second Workspace",
      "key": "a1b2c323"
    }
  ]
}

Actions

Create Account Workspace

Create a workspace in a specific account. | key: createAccountWorkspace

Input	Default	Notes	Example
Account Id string / Required accountId		The unique identifier of the item to retrieve.	123
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Workspace Name string / Required workspaceName		The name of the workspace account to create.	My Workspace

Example Payload for Create Account Workspace

{
  "data": {
    "account_id": "ABCD1234",
    "forms": [
      {
        "count": 12,
        "href": "https://api.typeform.com/workspaces/a1b2c3/forms"
      }
    ],
    "id": "a1b2c3",
    "name": "My Workspace",
    "self": [
      {
        "href": "https://api.typeform.com/workspaces/a1b2c3"
      }
    ],
    "shared": false
  }
}

Create Form

Create a form | key: createForm

Input	Default	Notes	Example
Connection connection / Required connection
CUI Settings string cuiSettings		The CUI settings for the form.	{ "avatar": "https://images.typeform.com/images/4BKUhw8A9cSM" }
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fields string fields		The fields for the form.	[ { "attachment": { "href": "https://www.youtube.com/watch?v=Uui3oT-XBxs", "properties": { "description": "Typeform Home documentary" }, "scale": 0.8, "type": "video" }, "properties": { "description": "Cool description for the date", "separator": "-", "structure": "DDMMYYYY" }, "ref": "nice_readable_date_reference", "title": "Date Title", "type": "date", "validations": { "required": false } }, { "layout": { "attachment": { "href": "https://images.typeform.com/images/4BKUhw8A9cSM", "type": "image" }, "placement": "right", "type": "float" }, "properties": { "alphabetical_order": false, "choices": [ { "label": "Foo" }, { "label": "Bar" } ], "description": "Cool description for the dropdown", "randomize": false }, "ref": "nice_readable_dropdown_reference", "title": "Dropdown Title", "type": "dropdown", "validations": { "required": false } } ]
Hidden string hidden		The hidden fields for the form.	[ "id", "created_at", "last_updated_at" ]
Logic string logic		The logic for the form.	[ { "actions": [ { "action": "jump", "condition": { "op": "equal", "vars": [ { "type": "field", "value": "nice_readable_number_reference" }, { "type": "constant", "value": 5 } ] }, "details": { "to": { "type": "field", "value": "nice_readable_rating_reference" } } }, { "action": "add", "condition": { "op": "is", "vars": [ { "type": "field", "value": "nice_readable_yes_no_reference" }, { "type": "constant", "value": true } ] }, "details": { "target": { "type": "variable", "value": "score" }, "value": { "type": "constant", "value": 5 } } } ], "ref": "nice_readable_yes_no_reference", "type": "field" } ]
Settings string setting		The settings for the form.	{ "autosave_progress": true, "facebook_pixel": "4347295725729872", "free_form_navigation": false, "google_analytics": "UA-1111-22", "google_tag_manager": "GTM-43959999", "hide_navigation": false, "is_public": false, "language": "en", "meta": { "allow_indexing": true, "canva_design_id": "DAElrx6aq-A", "description": "Cool meta description", "image": { "href": "https://images.typeform.com/images/4BKUhw8A9cSM" }, "title": "Meta title" }, "progress_bar": "percentage", "redirect_after_submit_url": "https://www.redirecttohere.com", "show_cookie_consent": false, "show_key_hint_on_choices": true, "show_number_of_submissions": false, "show_progress_bar": true, "show_question_number": true, "show_time_to_complete": true, "show_typeform_branding": false }
Thank You Screens string thankyouScreen		The thank you screens for the form.	[ { "attachment": { "href": "https://images.typeform.com/images/4BKUhw8A9cSM", "type": "image" }, "properties": { "button_mode": "redirect", "button_text": "start", "redirect_url": "https://www.typeform.com", "share_icons": false, "show_button": true }, "ref": "nice-readable-thank-you-ref", "title": "Thank you Title" } ]
Theme string 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.	https://api.typeform.com/themes/qHWOQ7
Title string / Required title		Title to use for the typeform.	My Title
Type string / Required type		Type of the form.
Variables string variables		The variables for the form.	{ "age": 28, "name": "typeform", "price": 10.59, "score": 0 }
Welcome Screens string welcomeScreens		The welcome screens for the form.	[ { "layout": { "attachment": { "href": "https://images.typeform.com/images/4BKUhw8A9cSM", "properties": { "decorative": true }, "type": "image" }, "placement": "left", "type": "split", "viewport_overrides": { "small": { "type": "wallpaper" } } }, "properties": { "button_text": "start", "description": "Cool description for the welcome", "show_button": true }, "ref": "nice-readable-welcome-ref", "title": "Welcome Title" } ]
Workspace URL string workspaceUrl		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.	https://api.typeform.com/workspaces/Aw33bz

Example Payload for Create Form

{
  "data": {
    "id": "id",
    "title": "title",
    "language": "en",
    "fields": [
      {}
    ],
    "hidden": [
      "string"
    ],
    "variables": {
      "score": 0,
      "price": 0
    },
    "welcome_screens": [
      {
        "ref": "nice-readable-welcome-ref",
        "title": "Welcome Title",
        "properties": {
          "description": "Cool description for the welcome",
          "show_button": true,
          "button_text": "start"
        },
        "attachment": {
          "type": "image",
          "href": {
            "image": {
              "value": "https://images.typeform.com/images/4bcd3"
            },
            "Pexels": {
              "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
            },
            "Vimeo": {
              "value": "https://vimeo.com/245714980"
            },
            "YouTube": {
              "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
            }
          },
          "scale": 0,
          "properties": {
            "description": "description"
          }
        },
        "layout": {
          "type": "float",
          "placement": "left",
          "attachment": {
            "type": "image",
            "href": {
              "image": {
                "value": "https://images.typeform.com/images/4bcd3"
              },
              "Pexels": {
                "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
              },
              "Vimeo": {
                "value": "https://vimeo.com/245714980"
              },
              "YouTube": {
                "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
              }
            },
            "scale": 0,
            "properties": {
              "description": "description"
            }
          },
          "viewport_overrides": {
            "small": {
              "type": "float",
              "placement": "left"
            },
            "large": {
              "type": "split",
              "placement": "right"
            }
          }
        }
      }
    ],
    "thankyou_screens": [
      {
        "ref": "nice-readable-thank-you-ref",
        "title": "Thank you Title",
        "type": "type",
        "properties": {
          "show_button": true,
          "button_text": "start",
          "button_mode": "redirect",
          "redirect_url": "https://www.typeform.com",
          "share_icons": true
        },
        "attachment": {
          "type": "image",
          "href": {
            "image": {
              "value": "https://images.typeform.com/images/4bcd3"
            },
            "Pexels": {
              "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
            },
            "Vimeo": {
              "value": "https://vimeo.com/245714980"
            },
            "YouTube": {
              "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
            }
          },
          "scale": 0,
          "properties": {
            "description": "description"
          }
        },
        "layout": {
          "type": "float",
          "placement": "left",
          "attachment": {
            "type": "image",
            "href": {
              "image": {
                "value": "https://images.typeform.com/images/4bcd3"
              },
              "Pexels": {
                "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
              },
              "Vimeo": {
                "value": "https://vimeo.com/245714980"
              },
              "YouTube": {
                "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
              }
            },
            "scale": 0,
            "properties": {
              "description": "description"
            }
          },
          "viewport_overrides": {
            "small": {
              "type": "float",
              "placement": "left"
            },
            "large": {
              "type": "split",
              "placement": "right"
            }
          }
        }
      }
    ],
    "logic": [
      {
        "type": "type",
        "ref": "ref",
        "actions": [
          {
            "action": "action",
            "details": {
              "to": {
                "type": "type",
                "value": "value"
              },
              "target": {
                "type": "type",
                "value": "value"
              },
              "value": {
                "type": "type"
              }
            },
            "condition": {
              "op": "op",
              "vars": [
                {
                  "type": "type",
                  "value": {}
                }
              ]
            }
          }
        ]
      }
    ],
    "theme": {
      "href": "https://api.typeform.com/themes/Fs24as"
    },
    "workspace": {
      "href": "https://api.typeform.com/workspaces/Aw33bz"
    },
    "_links": {
      "display": "https://subdomain.typeform.com/to/abc123"
    },
    "settings": {
      "language": "language",
      "is_public": true,
      "autosave_progress": true,
      "progress_bar": "proportion",
      "show_progress_bar": true,
      "show_typeform_branding": true,
      "show_time_to_complete": true,
      "show_number_of_submissions": true,
      "show_cookie_consent": true,
      "show_question_number": true,
      "show_key_hint_on_choices": true,
      "hide_navigation": true,
      "meta": {
        "title": "title",
        "allow_indexing": true,
        "description": "description",
        "image": {
          "href": "href"
        }
      },
      "redirect_after_submit_url": "redirect_after_submit_url",
      "google_analytics": "google_analytics",
      "facebook_pixel": "facebook_pixel",
      "google_tag_manager": "google_tag_manager",
      "milestones": [
        {
          "field_ref": "field_ref",
          "status": "status",
          "reason": "reason"
        }
      ],
      "enrichment_in_renderer": {
        "toggle": true,
        "active": true
      }
    },
    "cui_settings": {
      "avatar": "https://images.typeform.com/images/4bcd3",
      "is_typing_emulation_disabled": true,
      "typing_emulation_speed": "fast"
    }
  }
}

Create or Update Webhook

Create or Update a Webhook | key: createWebhook

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Enabled string enabled	true	True if you want to send responses to the webhook immediately. Otherwise, false.	phoenix
Form Id string / Required formId		Unique ID for the form.	u6nXL7
Form Response string formResponse		True if you want to send full responses to the webhook. Otherwise, false.
Form Response Partial string formResponsePartial		True if you want to send partial responses to the webhook. Otherwise, false.
Secret string / Required secret		Will be used to sign the webhook payload with HMAC SHA256, so that you can verify that it came from Typeform.	phoenix
Tag string / Required tag		Unique name you want to use for the webhook.	phoenix
URL string url		Webhook URL.	https://test.com

Example Payload for Create or Update Webhook

{
  "data": {
    "created_at": "2016-11-21T12:23:28.000Z",
    "enabled": true,
    "event_types": {
      "form_response": true,
      "form_response_partial": true
    },
    "form_id": "abc123",
    "id": "yRtagDm8AT",
    "tag": "phoenix",
    "updated_at": "2016-11-21T12:23:28.000Z",
    "url": "https://test.com",
    "verify_ssl": true
  }
}

Create Workspace

Create a workspace. | key: createWorkspace

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Workspace Name string / Required workspaceName		The name of the workspace.	My Workspace

Example Payload for Create Workspace

{
  "data": {
    "account_id": "ABCD1234",
    "forms": [
      {
        "count": 12,
        "href": "https://api.typeform.com/workspaces/a1b2c3/forms"
      }
    ],
    "id": "a1b2c3",
    "name": "My Workspace",
    "self": [
      {
        "href": "https://api.typeform.com/workspaces/a1b2c3"
      }
    ],
    "shared": false
  }
}

Delete Form

Delete a form. | key: deleteForm

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Form Id string / Required id		Unique ID for the form.	u6nXL7

Example Payload for Delete Form

{
  "data": {
    "message": "Deleted successfully"
  }
}

Delete Instance Webhooks

Delete all webhooks from a form for the instance url provided. | key: deleteAllInstanceWebhooks

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Form Id string / Required formId		Unique ID for the form.	u6nXL7
Instance URL string url		The instance URL to delete all webhooks from, if not provided, all webhooks from the current flow will be deleted.	https://test.com

Example Payload for Delete Instance Webhooks

{
  "data": "Deleted successfully"
}

Delete Response

Delete responses to a form. | key: deleteResponses

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Form Id string / Required id		Unique ID for the form.	u6nXL7
Included Response Ids string / Required includedResponseIds		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.	123

Example Payload for Delete Response

{
  "data": {
    "message": "Deleted successfully"
  }
}

Delete Webhook

Delete a webhook. | key: deleteWebhook

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Form Id string / Required formId		Unique ID for the form.	u6nXL7
Tag string / Required tag		Unique name you want to use for the webhook.	phoenix

Example Payload for Delete Webhook

{
  "data": {
    "message": "Deleted successfully"
  }
}

Delete Workspace

Delete a workspace. | key: deleteWorkspace

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Workspace Id string / Required id		The workspace Id to delete.	123

Example Payload for Delete Workspace

{
  "data": {
    "message": "Deleted successfully"
  }
}

Get All Response Files

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Form Id string / Required formId		Unique ID for the form.	u6nXL7

Example Payload for Get All Response Files

{
  "data": {
    "type": "Buffer",
    "data": [
      102,
      105,
      108,
      101,
      32,
      99,
      111,
      110,
      116,
      101,
      110,
      116
    ]
  }
}

Get File from Response

Download an uploaded file knowing its form, response, field and name. | key: getFileFromResponse

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Field Id string / Required fieldId		Unique ID for the file upload field	u6nXL7
Filename string / Required filename		Filename for the uploaded file	u6nXL7
Form Id string / Required formId		Unique ID for the form.	u6nXL7
Response Id string / Required responseId		Unique ID for the response.	u6nXL7

Example Payload for Get File from Response

{
  "data": {
    "type": "Buffer",
    "data": [
      102,
      105,
      108,
      101,
      32,
      99,
      111,
      110,
      116,
      101,
      110,
      116
    ]
  }
}

Get Form

Retrieve a form. | key: getForm

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Form Id string / Required id		Unique ID for the form.	u6nXL7

Example Payload for Get Form

{
  "data": {
    "id": "id",
    "title": "title",
    "language": "en",
    "fields": [
      {}
    ],
    "hidden": [
      "string"
    ],
    "variables": {
      "score": 0,
      "price": 0
    },
    "welcome_screens": [
      {
        "ref": "nice-readable-welcome-ref",
        "title": "Welcome Title",
        "properties": {
          "description": "Cool description for the welcome",
          "show_button": true,
          "button_text": "start"
        },
        "attachment": {
          "type": "image",
          "href": {
            "image": {
              "value": "https://images.typeform.com/images/4bcd3"
            },
            "Pexels": {
              "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
            },
            "Vimeo": {
              "value": "https://vimeo.com/245714980"
            },
            "YouTube": {
              "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
            }
          },
          "scale": 0,
          "properties": {
            "description": "description"
          }
        },
        "layout": {
          "type": "float",
          "placement": "left",
          "attachment": {
            "type": "image",
            "href": {
              "image": {
                "value": "https://images.typeform.com/images/4bcd3"
              },
              "Pexels": {
                "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
              },
              "Vimeo": {
                "value": "https://vimeo.com/245714980"
              },
              "YouTube": {
                "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
              }
            },
            "scale": 0,
            "properties": {
              "description": "description"
            }
          },
          "viewport_overrides": {
            "small": {
              "type": "float",
              "placement": "left"
            },
            "large": {
              "type": "split",
              "placement": "right"
            }
          }
        }
      }
    ],
    "thankyou_screens": [
      {
        "ref": "nice-readable-thank-you-ref",
        "title": "Thank you Title",
        "type": "type",
        "properties": {
          "show_button": true,
          "button_text": "start",
          "button_mode": "redirect",
          "redirect_url": "https://www.typeform.com",
          "share_icons": true
        },
        "attachment": {
          "type": "image",
          "href": {
            "image": {
              "value": "https://images.typeform.com/images/4bcd3"
            },
            "Pexels": {
              "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
            },
            "Vimeo": {
              "value": "https://vimeo.com/245714980"
            },
            "YouTube": {
              "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
            }
          },
          "scale": 0,
          "properties": {
            "description": "description"
          }
        },
        "layout": {
          "type": "float",
          "placement": "left",
          "attachment": {
            "type": "image",
            "href": {
              "image": {
                "value": "https://images.typeform.com/images/4bcd3"
              },
              "Pexels": {
                "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
              },
              "Vimeo": {
                "value": "https://vimeo.com/245714980"
              },
              "YouTube": {
                "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
              }
            },
            "scale": 0,
            "properties": {
              "description": "description"
            }
          },
          "viewport_overrides": {
            "small": {
              "type": "float",
              "placement": "left"
            },
            "large": {
              "type": "split",
              "placement": "right"
            }
          }
        }
      }
    ],
    "logic": [
      {
        "type": "type",
        "ref": "ref",
        "actions": [
          {
            "action": "action",
            "details": {
              "to": {
                "type": "type",
                "value": "value"
              },
              "target": {
                "type": "type",
                "value": "value"
              },
              "value": {
                "type": "type"
              }
            },
            "condition": {
              "op": "op",
              "vars": [
                {
                  "type": "type",
                  "value": {}
                }
              ]
            }
          }
        ]
      }
    ],
    "theme": {
      "href": "https://api.typeform.com/themes/Fs24as"
    },
    "workspace": {
      "href": "https://api.typeform.com/workspaces/Aw33bz"
    },
    "_links": {
      "display": "https://subdomain.typeform.com/to/abc123"
    },
    "settings": {
      "language": "language",
      "is_public": true,
      "autosave_progress": true,
      "progress_bar": "proportion",
      "show_progress_bar": true,
      "show_typeform_branding": true,
      "show_time_to_complete": true,
      "show_number_of_submissions": true,
      "show_cookie_consent": true,
      "show_question_number": true,
      "show_key_hint_on_choices": true,
      "hide_navigation": true,
      "meta": {
        "title": "title",
        "allow_indexing": true,
        "description": "description",
        "image": {
          "href": "href"
        }
      },
      "redirect_after_submit_url": "redirect_after_submit_url",
      "google_analytics": "google_analytics",
      "facebook_pixel": "facebook_pixel",
      "google_tag_manager": "google_tag_manager",
      "milestones": [
        {
          "field_ref": "field_ref",
          "status": "status",
          "reason": "reason"
        }
      ],
      "enrichment_in_renderer": {
        "toggle": true,
        "active": true
      }
    },
    "cui_settings": {
      "avatar": "https://images.typeform.com/images/4bcd3",
      "is_typing_emulation_disabled": true,
      "typing_emulation_speed": "fast"
    }
  }
}

Get Webhook

Retrieve a single webhook. | key: getWebhook

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Form Id string / Required formId		Unique ID for the form.	u6nXL7
Tag string / Required tag		Unique name you want to use for the webhook.	phoenix

Example Payload for Get Webhook

{
  "data": {
    "created_at": "2016-11-21T12:23:28.000Z",
    "enabled": true,
    "event_types": {
      "form_response": true,
      "form_response_partial": true
    },
    "form_id": "abc123",
    "id": "yRtagDm8AT",
    "tag": "phoenix",
    "updated_at": "2016-11-21T12:23:28.000Z",
    "url": "https://test.com",
    "verify_ssl": true
  }
}

Get Workspace

Retrieve a workspace. | key: getWorkspace

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Workspace Id string / Required id		The workspace Id to retrieve.	123

Example Payload for Get Workspace

{
  "data": {
    "account_id": "ABCD1234",
    "forms": [
      {
        "count": 12,
        "href": "https://api.typeform.com/workspaces/a1b2c3/forms"
      }
    ],
    "id": "a1b2c3",
    "name": "My Workspace",
    "self": [
      {
        "href": "https://api.typeform.com/workspaces/a1b2c3"
      }
    ],
    "shared": false
  }
}

List Account Workspaces

Retrieve all workspaces you have access to within the specific account. | key: listAccountWorkspaces

Input	Default	Notes	Example
Account Id string / Required accountId		The unique identifier of the item to retrieve.	123
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all the records ignoring the rest of the parameters.
Page string page		The page of results to retrieve.	1
Page Size string pageSize		Number of results to retrieve per page. Default is 10. Maximum is 200.	50
Search string search		Returns items that contain the specified string.	My Search

Example Payload for List Account Workspaces

{
  "data": {
    "items": [
      {
        "account_id": "ABCD1234",
        "forms": [
          {
            "count": 12,
            "href": "https://api.typeform.com/workspaces/a1b2c3/forms"
          }
        ],
        "id": "a1b2c3",
        "name": "My Workspace",
        "self": [
          {
            "href": "https://api.typeform.com/workspaces/a1b2c3"
          }
        ],
        "shared": false
      }
    ],
    "page_count": 1,
    "total_items": 10
  }
}

List Forms

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

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all the records ignoring the rest of the parameters.
Order By string orderBy		Order type.
Page string page		The page of results to retrieve.	1
Page Size string pageSize		Number of results to retrieve per page. Default is 10. Maximum is 200.	50
Search string search		Returns items that contain the specified string.	My Search
Sort By string sortBy		Field to sort the results by.
Workspace Id string workspaceId		Retrieve typeforms for the specified workspace.	123

Example Payload for List Forms

{
  "data": {
    "items": [
      {
        "id": "id",
        "title": "title",
        "language": "en",
        "fields": [
          {}
        ],
        "hidden": [
          "string"
        ],
        "variables": {
          "score": 0,
          "price": 0
        },
        "welcome_screens": [
          {
            "ref": "nice-readable-welcome-ref",
            "title": "Welcome Title",
            "properties": {
              "description": "Cool description for the welcome",
              "show_button": true,
              "button_text": "start"
            },
            "attachment": {
              "type": "image",
              "href": {
                "image": {
                  "value": "https://images.typeform.com/images/4bcd3"
                },
                "Pexels": {
                  "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
                },
                "Vimeo": {
                  "value": "https://vimeo.com/245714980"
                },
                "YouTube": {
                  "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
                }
              },
              "scale": 0,
              "properties": {
                "description": "description"
              }
            },
            "layout": {
              "type": "float",
              "placement": "left",
              "attachment": {
                "type": "image",
                "href": {
                  "image": {
                    "value": "https://images.typeform.com/images/4bcd3"
                  },
                  "Pexels": {
                    "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
                  },
                  "Vimeo": {
                    "value": "https://vimeo.com/245714980"
                  },
                  "YouTube": {
                    "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
                  }
                },
                "scale": 0,
                "properties": {
                  "description": "description"
                }
              },
              "viewport_overrides": {
                "small": {
                  "type": "float",
                  "placement": "left"
                },
                "large": {
                  "type": "split",
                  "placement": "right"
                }
              }
            }
          }
        ],
        "thankyou_screens": [
          {
            "ref": "nice-readable-thank-you-ref",
            "title": "Thank you Title",
            "type": "type",
            "properties": {
              "show_button": true,
              "button_text": "start",
              "button_mode": "redirect",
              "redirect_url": "https://www.typeform.com",
              "share_icons": true
            },
            "attachment": {
              "type": "image",
              "href": {
                "image": {
                  "value": "https://images.typeform.com/images/4bcd3"
                },
                "Pexels": {
                  "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
                },
                "Vimeo": {
                  "value": "https://vimeo.com/245714980"
                },
                "YouTube": {
                  "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
                }
              },
              "scale": 0,
              "properties": {
                "description": "description"
              }
            },
            "layout": {
              "type": "float",
              "placement": "left",
              "attachment": {
                "type": "image",
                "href": {
                  "image": {
                    "value": "https://images.typeform.com/images/4bcd3"
                  },
                  "Pexels": {
                    "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
                  },
                  "Vimeo": {
                    "value": "https://vimeo.com/245714980"
                  },
                  "YouTube": {
                    "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
                  }
                },
                "scale": 0,
                "properties": {
                  "description": "description"
                }
              },
              "viewport_overrides": {
                "small": {
                  "type": "float",
                  "placement": "left"
                },
                "large": {
                  "type": "split",
                  "placement": "right"
                }
              }
            }
          }
        ],
        "logic": [
          {
            "type": "type",
            "ref": "ref",
            "actions": [
              {
                "action": "action",
                "details": {
                  "to": {
                    "type": "type",
                    "value": "value"
                  },
                  "target": {
                    "type": "type",
                    "value": "value"
                  },
                  "value": {
                    "type": "type"
                  }
                },
                "condition": {
                  "op": "op",
                  "vars": [
                    {
                      "type": "type",
                      "value": {}
                    }
                  ]
                }
              }
            ]
          }
        ],
        "theme": {
          "href": "https://api.typeform.com/themes/Fs24as"
        },
        "workspace": {
          "href": "https://api.typeform.com/workspaces/Aw33bz"
        },
        "_links": {
          "display": "https://subdomain.typeform.com/to/abc123"
        },
        "settings": {
          "language": "language",
          "is_public": true,
          "autosave_progress": true,
          "progress_bar": "proportion",
          "show_progress_bar": true,
          "show_typeform_branding": true,
          "show_time_to_complete": true,
          "show_number_of_submissions": true,
          "show_cookie_consent": true,
          "show_question_number": true,
          "show_key_hint_on_choices": true,
          "hide_navigation": true,
          "meta": {
            "title": "title",
            "allow_indexing": true,
            "description": "description",
            "image": {
              "href": "href"
            }
          },
          "redirect_after_submit_url": "redirect_after_submit_url",
          "google_analytics": "google_analytics",
          "facebook_pixel": "facebook_pixel",
          "google_tag_manager": "google_tag_manager",
          "milestones": [
            {
              "field_ref": "field_ref",
              "status": "status",
              "reason": "reason"
            }
          ],
          "enrichment_in_renderer": {
            "toggle": true,
            "active": true
          }
        },
        "cui_settings": {
          "avatar": "https://images.typeform.com/images/4bcd3",
          "is_typing_emulation_disabled": true,
          "typing_emulation_speed": "fast"
        }
      }
    ]
  }
}

List Responses

Returns form responses and date and time of form landing and submission. | key: listResponses

Input	Default	Notes	Example
Connection connection / Required connection
Custom Query Params string Key Value List customQueryParams		Custom fields filter	key1=value1
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all the records ignoring the rest of the parameters.
Form Id string / Required id		Unique ID for the form.	u6nXL7
Page string page		The page of results to retrieve.	1
Page Size string pageSize		Number of results to retrieve per page. Default is 10. Maximum is 200.	50
Search string search		Returns items that contain the specified string.	My Search

Example Payload for List Responses

{
  "data": {
    "items": [
      {
        "answers": [
          {
            "field": {
              "id": "hVONkQcnSNRj",
              "ref": "my_custom_dropdown_reference",
              "type": "dropdown"
            },
            "text": "Job opportunities",
            "type": "text"
          },
          {
            "boolean": false,
            "field": {
              "id": "RUqkXSeXBXSd",
              "ref": "my_custom_yes_no_reference",
              "type": "yes_no"
            },
            "type": "boolean"
          },
          {
            "boolean": true,
            "field": {
              "id": "gFFf3xAkJKsr",
              "ref": "my_custom_legal_reference",
              "type": "legal"
            },
            "type": "boolean"
          },
          {
            "field": {
              "id": "JwWggjAKtOkA",
              "ref": "my_custom_short_text_reference",
              "type": "short_text"
            },
            "text": "Lian",
            "type": "text"
          },
          {
            "email": "lian1078@other.com",
            "field": {
              "id": "SMEUb7VJz92Q",
              "ref": "my_custom_email_reference",
              "type": "email"
            },
            "type": "email"
          },
          {
            "field": {
              "id": "pn48RmPazVdM",
              "ref": "my_custom_number_reference",
              "type": "number"
            },
            "number": 1,
            "type": "number"
          },
          {
            "field": {
              "id": "Q7M2XAwY04dW",
              "ref": "my_custom_number2_reference",
              "type": "number"
            },
            "number": 1,
            "type": "number"
          },
          {
            "field": {
              "id": "WOTdC00F8A3h",
              "ref": "my_custom_rating_reference",
              "type": "rating"
            },
            "number": 3,
            "type": "number"
          },
          {
            "field": {
              "id": "DlXFaesGBpoF",
              "ref": "my_custom_long_text_reference",
              "type": "long_text"
            },
            "text": "It's a big, busy city. I moved here for a job, but I like it, so I am planning to stay. I have made good friends here.",
            "type": "text"
          },
          {
            "field": {
              "id": "NRsxU591jIW9",
              "ref": "my_custom_opinion_scale_reference",
              "type": "opinion_scale"
            },
            "number": 1,
            "type": "number"
          },
          {
            "choices": {
              "labels": [
                "New York",
                "Tokyo"
              ]
            },
            "field": {
              "id": "PNe8ZKBK8C2Q",
              "ref": "my_custom_picture_choice_reference",
              "type": "picture_choice"
            },
            "type": "choices"
          },
          {
            "date": "2012-03-20T00:00:00Z",
            "field": {
              "id": "KoJxDM3c6x8h",
              "ref": "my_custom_date_reference",
              "type": "date"
            },
            "type": "date"
          },
          {
            "choice": {
              "label": "A friend's experience in Sydney"
            },
            "field": {
              "id": "ceIXxpbP3t2q",
              "ref": "my_custom_multiple_choice_reference",
              "type": "multiple_choice"
            },
            "type": "choice"
          },
          {
            "choices": {
              "labels": [
                "New York",
                "Tokyo"
              ]
            },
            "field": {
              "id": "abISxvbD5t1p",
              "ref": "my_custom_ranking_reference",
              "type": "ranking"
            },
            "type": "choices"
          },
          {
            "choice": {
              "label": "Tokyo"
            },
            "field": {
              "id": "k6TP9oLGgHjl",
              "ref": "my_custom_multiple_choice2_reference",
              "type": "multiple_choice"
            },
            "type": "choice"
          }
        ],
        "calculated": {
          "score": 2
        },
        "hidden": {},
        "landed_at": "2017-09-14T22:33:59Z",
        "landing_id": "21085286190ffad1248d17c4135ee56f",
        "metadata": {
          "browser": "default",
          "network_id": "respondent_network_id",
          "platform": "other",
          "referer": "https://user_id.typeform.com/to/lR6F4j",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/603.3.8 (KHTML, like Gecko) Version/10.1.2 Safari/603.3.8"
        },
        "response_id": "21085286190ffad1248d17c4135ee56f",
        "submitted_at": "2017-09-14T22:38:22Z",
        "token": "test21085286190ffad1248d17c4135ee56f",
        "variables": [
          {
            "key": "score",
            "number": 2,
            "type": "number"
          },
          {
            "key": "name",
            "text": "typeform",
            "type": "text"
          }
        ]
      }
    ],
    "page_count": 1,
    "total_items": 4
  }
}

List Webhooks

Retrieve all webhooks for the specified Typeform. | key: listWebhooks

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Form Id string / Required formId		Unique ID for the form.	u6nXL7

Example Payload for List Webhooks

{
  "data": {
    "items": [
      {
        "created_at": "2016-11-21T12:23:28.000Z",
        "enabled": true,
        "event_types": {
          "form_response": true,
          "form_response_partial": true
        },
        "form_id": "abc123",
        "id": "yRtagDm8AT",
        "tag": "phoenix",
        "updated_at": "2016-11-21T12:23:28.000Z",
        "url": "https://test.com",
        "verify_ssl": true
      }
    ]
  }
}

List Workspaces

Retrieve all workspaces the user has access to. | key: listWorkspaces

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	If true, it will fetch all the records ignoring the rest of the parameters.
Page string page		The page of results to retrieve.	1
Page Size string pageSize		Number of results to retrieve per page. Default is 10. Maximum is 200.	50
Search string search		Returns items that contain the specified string.	My Search

Example Payload for List Workspaces

{
  "data": {
    "items": [
      {
        "account_id": "ABCD1234",
        "forms": [
          {
            "count": 12,
            "href": "https://api.typeform.com/workspaces/a1b2c3/forms"
          }
        ],
        "id": "a1b2c3",
        "name": "My Workspace",
        "self": [
          {
            "href": "https://api.typeform.com/workspaces/a1b2c3"
          }
        ],
        "shared": false
      }
    ]
  }
}

Raw Request

Send raw HTTP request to Typeform API | key: rawRequest

Input	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enable this to log the request and response
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt. Specify 0 for no retries.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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.
Response Type string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	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.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required 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	/forms
Use Exponential Backoff boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

Update Form

Update a form. | key: updateForm

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Form Id string / Required id		Unique ID for the form.	u6nXL7
Operations code / Required operations		Operations to perform on the data.

Example Payload for Update Form

{
  "data": {
    "message": "Operations applied successfully"
  }
}

Update Workspace

Update a workspace. | key: updateWorkspace

Input	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Workspace Id string / Required id		The workspace Id to update.	123
Operations code / Required operations		Operations to perform on the data.

Example Payload for Update Workspace

{
  "data": {
    "message": "Operations applied successfully"
  }
}

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

Description​

API Documentation​

Connections​

OAuth 2.0​

Personal Token​

Triggers​

Typeform Webhook Trigger​

Data Sources​

Select Account Workspaces​

Select Form​

Select Workspaces​

Actions​

Create Account Workspace​

Create Form​

Create or Update Webhook​

Create Workspace​

Delete Form​

Delete Instance Webhooks​

Delete Response​

Delete Webhook​

Delete Workspace​

Get All Response Files​

Get File from Response​

Get Form​

Get Webhook​

Get Workspace​

List Account Workspaces​

List Forms​

List Responses​

List Webhooks​

List Workspaces​

Raw Request​

Update Form​

Update Workspace​

Description

API Documentation

Connections

OAuth 2.0

Personal Token

Triggers

Typeform Webhook Trigger

Data Sources

Select Account Workspaces

Select Form

Select Workspaces

Actions

Create Account Workspace

Create Form

Create or Update Webhook

Create Workspace

Delete Form

Delete Instance Webhooks

Delete Response

Delete Webhook

Delete Workspace

Get All Response Files

Get File from Response

Get Form

Get Webhook

Get Workspace

List Account Workspaces

List Forms

List Responses

List Webhooks

List Workspaces

Raw Request

Update Form

Update Workspace