Typeform

Typeform is an online survey and form-building tool that enables users to create interactive and engaging forms for collecting data and feedback.

Categories: Surveys and Feedback

Type: typeform/v1

Connections

Version: 1

Bearer Token

Properties

Name	Label	Type	Description	Required
token	Personal Access Token	STRING		true

Connection Setup

Using Personal Access Token

Log into your Typeform account.
Select your profile avatar in the upper right.
Select Your settings.
Select Personal tokens.
Select Generate a new token.
Give your token a name, like Bytechef Integration.
For scopes, select Custom scopes. Select these scopes:
- Forms: Read, Write
- Webhooks: Read, Write
- Workspaces: Read
Click Generate token.
Copy the token and use it to create a connection in ByteChef.

Actions

Create Empty Form

Name: createEmptyForm

Creates a new empty form.

Properties

Name	Label	Type	Description	Required
title	Title	STRING	Title to use for the form.	true
type	Type	STRING Options quiz, classification, score, branching, classification_branching, score_branching	Form type for the typeform.	false
workspace	Workspace URL	STRING	URL of the workspace to use for the typeform.	true

Example JSON Structure

{
  "label" : "Create Empty Form",
  "name" : "createEmptyForm",
  "parameters" : {
    "title" : "",
    "type" : "",
    "workspace" : ""
  },
  "type" : "typeform/v1/createEmptyForm"
}

Properties

Name	Type	Description
id	STRING	ID of the form.
type	STRING	Type of the form.
title	STRING	Title of the form.
workspace	OBJECT Properties {STRING(href)}
theme	OBJECT Properties {STRING(href)}
settings	OBJECT Properties {STRING(language), STRING(progress_bar), {BOOLEAN(allow_indexing)}(meta), BOOLEAN(hide_navigation), BOOLEAN(is_public), BOOLEAN(is_trial), BOOLEAN(show_progress_bar), BOOLEAN(show_typeform_branding), BOOLEAN(are_uploads_public), BOOLEAN(show_time_to_complete), BOOLEAN(show_number_of_submissions), BOOLEAN(show_cookie_consent), BOOLEAN(show_question_number), BOOLEAN(show_key_hint_on_choices), BOOLEAN(autosave_progress), BOOLEAN(free_form_navigation), BOOLEAN(use_lead_qualification), BOOLEAN(pro_subdomain_enabled), BOOLEAN(auto_translate), BOOLEAN(partial_responses_to_all_integrations)}
_links	OBJECT Properties {STRING(display), STRING(responses)}

Output Example

{
  "id" : "",
  "type" : "",
  "title" : "",
  "workspace" : {
    "href" : ""
  },
  "theme" : {
    "href" : ""
  },
  "settings" : {
    "language" : "",
    "progress_bar" : "",
    "meta" : {
      "allow_indexing" : false
    },
    "hide_navigation" : false,
    "is_public" : false,
    "is_trial" : false,
    "show_progress_bar" : false,
    "show_typeform_branding" : false,
    "are_uploads_public" : false,
    "show_time_to_complete" : false,
    "show_number_of_submissions" : false,
    "show_cookie_consent" : false,
    "show_question_number" : false,
    "show_key_hint_on_choices" : false,
    "autosave_progress" : false,
    "free_form_navigation" : false,
    "use_lead_qualification" : false,
    "pro_subdomain_enabled" : false,
    "auto_translate" : false,
    "partial_responses_to_all_integrations" : false
  },
  "_links" : {
    "display" : "",
    "responses" : ""
  }
}

Triggers

New Submission

Name: newSubmission

Triggers when form is submitted.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Description	Required
formId	Form ID	STRING	ID for the form. Find in your form URL. For example, in the URL "https://mysite.typeform.com/to/u6nXL7" the form id is u6nXL7.	true

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "New Submission",
  "name" : "newSubmission",
  "parameters" : {
    "formId" : ""
  },
  "type" : "typeform/v1/newSubmission"
}

How to find the Form ID

You can find your Typeform Form ID directly in your browser’s address bar when you open the form.

Log in to your Typeform account and go to your workspace.
Open the form you want to use.
Look at the URL in your browser. You’ll see one of these patterns:
- https://admin.typeform.com/form/ABC12345/...
- https://admin.typeform.com/to/XYZ67890/...
The Form ID is the unique alphanumeric string immediately after /form/ or /to/ and before the next / or ?.
- For example, in https://admin.typeform.com/form/ABC12345/, the Form ID is ABC12345.

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

On this page