Skip to main content

Typeform Pipe

This article is still being written, please check back soon. 

Build beautiful, interactive forms get more responses. No coding needed. Templates for quizzes, research, feedback, lead generation, and more. Typeform gives you direct control over your Typeform, images, and themes, plus more customization options to make your Typeform even more engaging.

Create an account here: https://admin.typeform.com/signup

You can generate personal access tokens in your Typeform account. Here's how:

  1. Log in to your account at Typeform.
  2. In the upper-right corner, in the drop-down menu next to your profile photo, click My Account.
  3. In the left menu, click Personal tokens.
  4. Click Generate a new token.
  5. In the Token name field, type a name for the token to help you identify it.
  6. Choose needed scopes (API actions this token can perform - or permissions it has). See here for more details on scopes.
  7. Click Generate token.

Global Parameters

There are 2 Global Parameters in this pipe.

  • Authorization
  • Content-Type
global.png

All API calls below must contain the authorization details in the global parameters. 

API Calls

All the API Calls in this Pipe can be customized, but we've added several to help you get started and expedite the time needed to get you up and running with some of the basic uses. 

Workspace

  • Add a Workspace
  • Update a Workspace
  • Add a Team Member to Workspace

Add a Workspace

Allows you to create workspaces for each stage in your data collection and analysis process: Development, Collection, and Analysis.

URL

First you can pass a URL and Method in the overview tab for create a new Workspace. The required URL and method that must be included below :

overview_create_workspace.PNG

Parameters

Add required parameters values for dynamically assigned in the API Call request. Set required Parameters must be included in parameters tab.

  • name - The workspace's name ( Required ).

parameter_create_workspace.PNG

Headers

Here required header value must be included in headers tab. Assign parameter like {Content-Type}, {Authorization} that created at global parameter tab. 

header_create_workspace.PNG

Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for creating a workspace. Here {name} is assigned parameters that created in parameters tab.

request_create_workspace.PNG 

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 201 status.

Note: Here Authorization allow "bearer {your_access_token}".

test_create_workspace.PNG

Response

Built in responses already added are below. 

  • Account ID
  • Form URL
  • Workspace ID
  • Workspace Name
  • Self href
  • Total Forms
  • Default Form

response_create_workspace.PNG

Update a Workspace

Suppose that you renamed the "IT Sector" stage to "IT Information." To change the workspace name,

URL

First you can pass a URL and Method in the overview tab for update a workspace. The required URL and method that must be included below :

  • Method :PUT
  • Request URL : https://api.typeform.com/workspaces/{workspace_id}
Parameters

Set Parameters must be included in parameters tab.

  • workspace_id - Workspace Unique identifier( Required )
  • name - New name of workspace ( Required ).
Headers

There are 2 header Parameters must be included below. 

  • Authorization
  • Content-Type - application/json
Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for update a Workspace. Here {name} is assign parameter. here change name of Workspace. 

request_update_workspace.PNG

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 204 status and return empty object.

test_update_workspace.PNG

Response

 Here data mapping is not possible because of returns empty object response.

Add a Team Member to Workspace

Allow a add a team member to workspace for right team members have access to your workspace.

URL

First you can pass a URL and Method in the overview tab for add a team member to workspace. The required URL and method that must be included below :

  • Method :PATCH
  • Request URL : https://api.typeform.com/workspaces/{workspace_id}
Parameters

Set Parameters must be included in parameters tab.

  • workspace_id - Workspace Unique identifier ( Required ).
  • email - Email Unique identifier ( Required ).

Note: Allow members who currently have access to the workspace for email parameter.

Headers

There are 2 header Parameters must be included below. 

  • Authorization
  • Content-Type - application/json
Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for add a team member to workspace. Here {email} is assign parameter. 

request_add_users_workspace.PNG

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 204 status and return empty object.

Note: Allow members who currently have access to the workspace for Email of Team Member field.

test_add_user_workspace.PNG

Response

 Here data mapping is not possible because of returns empty object response.

Form

  • Create a Form
  • Update a Form
  • Delete a Form
  • Retrieve a Form
  • Retrieve a Custom Form Message

Create a Form

Allows you to create form.

URL

First you can pass a URL and Method in the overview tab for create a new form. The required URL and method that must be included below :

  • Method : POST
  • Request URL : https://api.typeform.com/forms
Parameters

Add required parameters values for dynamically assigned in the API Call request. Set required Parameters must be included in parameters tab.

  • title - Title to use for the form. ( Required ).
  • workspace_id - Workspace Unique identifier ( Required ).
Headers

There are 2 header Parameters must be included below. 

  • Authorization
  • Content-Type - application/json
Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for creating a form to workspace. Here {title} and {workspace} is assigned parameters that created in parameters tab.

request_create_form.PNG

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 201 status.

Note: Here Authorization allow "bearer {your_access_token}".

test_create_form.PNG

Response

Built in responses already added are below. 

  • Id
  • Type
  • Title
  • Workspace href
  • Theme href
  • Display Link

Update a Form

Suppose that you renamed the "Social Media Privacy" stage to "Workplace Monitoring." To change the form name,

URL

First you can pass a URL and Method in the overview tab for update a form. The required URL and method that must be included below :

  • Method :PUT
  • Request URL : https://api.typeform.com/forms/{form_id}
Parameters

Set Parameters must be included in parameters tab.

  • workspace_id - Workspace Unique identifier( Required ).
  • title - Title to use for the form. ( Required ).
Headers

There are 2 header Parameters must be included below. 

  • Authorization
  • Content-Type - application/json
Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for update a form. Here {title} and {workspace} is assign parameter. here change name of form. 

request_update_form.PNG

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

Test_update_form.PNG

Response

Built in responses already added are below. 

  • Id
  • Type
  • Title
  • Workspace href
  • Theme href
  • Display Link

Retrieve a Form

Retrieves a list of JSON descriptions for all forms in your Typeform account (public and private). Forms are sorted by creation date in descending order.

URL

First you can pass a URL and Method in the overview tab for getting a form detail. The required URL and method that must be included below :

  • Method : GET
  • Request URL : https://api.typeform.com/forms/{form_id}
Parameters

Set Parameters must be included in parameters tab.

  • form_id -  Form Unique identifier( Required ).
Headers

There are 2 header Parameters must be included below. 

  • Authorization
  • Content-Type - application/json
Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

test_retrieve_from.PNG

Response

Built in responses already added are below. 

  • Id
  • Type
  • Title
  • Workspace href
  • Theme href
  • Display Link

Retrieve a Custom Form Message

Retrieves the customizable messages for a form (specified by form_id) using the form's specified language.

URL

First you can pass a URL and Method in the overview tab for getting a custom form message. The required URL and method that must be included below :

  • Method : GET
  • Request URL : https://api.typeform.com/forms/{form_id}/messages
Parameters

Set Parameters must be included in parameters tab.

  • form_id -  Form Unique identifier( Required ).
Headers

There are 2 header Parameters must be included below. 

  • Authorization
  • Content-Type - application/json
Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

test_retrieve_message.PNG

Response

Built in responses already added are below.

Note: Here custom message is only one because of in "Add or Update a Custom Message" pipe set only one custom message. If you add more then one custom message then list above custom message you set in "Add or Update a Custom Message" pipe. 

  • Warning Connection Message -  For label.warning.connection

Add or Update a Custom Message

Specifies new values for the customizable messages in a form (specified by form_id).

URL

First you can pass a URL and Method in the overview tab for add or update a custom message. The required URL and method that must be included below :

  • Method :PUT
  • Request URL : https://api.typeform.com/forms/{form_id}/messages
Parameters

Set Parameters must be included in parameters tab.

  • form_id -  Form Unique identifier( Required ).
  • connection - Server connection error message.
Headers

There are 2 header Parameters must be included below. 

  • Authorization
  • Content-Type - application/json
Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for add or update a custom message. Here {connection} is assign parameter.
Note: If you want to add more custom message, set a key and value as object form like bellow screenshot.   

request_create_update_message.PNG

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

test_retrieve_message.PNG

Response

Built in responses already added are below.

Note: Here custom message is only one because of in "Add or Update a Custom Message" set only one custom message. If you add more then one custom message then list bellow custom message you set in "Add or Update a Custom Message". 

  • Warning Connection Message -  For label.warning.connection

Image

  • Create a Image
  • Delete a Image
  • Retrieve a Image
  • Retrieve a Image by Size
  • Retrieve a Image Collection

Create a Image

Adds an image in your Typeform account.

Specify the URL of your image or send your image in base64 format, which encodes the image data as ASCII text. You can use a tool like Base64 Image Encoder to get the base64 code for the image you want to add.

URL

First you can pass a URL and Method in the overview tab for create a Image. The required URL and method that must be included below :

  • Method : POST
  • Request URL : https://api.typeform.com/images
Parameters

Add required parameters values for dynamically assigned in the API Call request. Set required Parameters must be included in parameters tab.

  • form_id - Form unique id ( Required ).
  • image - Base64 code for the image ( Required ).
  • file_name - File name for the image ( Required ).
Headers

There are 2 header Parameters must be included below. 

  • Authorization
  • Content-Type - application/json
Request

Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for creating a new image. Here {image} and {file_name} is assigned parameters that created in parameters tab.

request_create_image.PNG

Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 201 status.

Note: Here Authorization allow "bearer {your_access_token}".

test_create_image.PNG

Note: Image field allow base64 image string.

Response

Built in responses already added are below. 

  • Id
  • Src
  • File name
  • Width
  • Height
  • Media type

Retrieve a Image

Retrieves the JSON description or the binary of the original image for the specified image_id. Default is to return the binary of the original image. Use the Accept header to specify application/json to return the JSON description of the image instead.

URL

First you can pass a URL and Method in the overview tab for getting a image detail. The required URL and method that must be included below :

  • Method : GET
  • Request URL : https://api.typeform.com/images/{image_id}
Parameters

Set Parameters must be included in parameters tab.

  • image_id -  Image unique identifier( Required ).
Headers

There are 2 header Parameters must be included below. 

  • Authorization
  • Accept - application/json
Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

test-retrieve-image-form.PNG

Response

Built in responses already added are below. 

  • Id
  • Src
  • File name
  • Width
  • Height
  • Media type

Retrieve a Image by Size

Retrieve the JSON description or the binary of the requested image. Use the Accept header to specify application/json to return the JSON description of the image instead.

URL

First you can pass a URL and Method in the overview tab for getting a image by size. The required URL and method that must be included below :

  • Method : GET
  • Request URL : https://images.typeform.com/images/{image_id}/image/{size}
Parameters

Set Parameters must be included in parameters tab.

  • image_id -  Image unique identifier ( Required ).
  • size - Allow Image size default mobile thumbnail ( Required ).
Headers

There are 2 header Parameters must be included below. 

  • Authorization
  • Accept - application/json
Test

Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

test_retrieve_image_by_size.PNG

Response

Built in responses already added are below. 

  • Id
  • File name
  • Width
  • Height
  • Media type

Retrieve a Image Collection

Retrieves a list of JSON descriptions for all images in your Typeform account. Images are listed in reverse-chronological order based on the date you added them to your account.

URL

First you can pass a URL and Method in the overview tab for getting a image collection. The required URL and method that must be included below :

  • Method : GET
  • Request URL : https://api.typeform.com/images
    Headers

    There are 2 header Parameters must be included below. 

    • Authorization
    • Accept - application/json
    Test

    Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

    test_retrieve_image_collection.PNG

    Response

    Here data mapping is not set because of result is more then one.

    Delete a Image

    Deletes an image from your Typeform account.

    URL

    First you can pass a URL and Method in the overview tab for delete image. The required URL and method that must be included below :

    Parameters

    Set Parameters must be included in parameters tab.

    • image_id -  Image unique identifier ( Required ).
    Headers

    There are 2 header Parameters must be included below. 

    • Authorization
    • Content-Type - application/json
    Test

    Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 204 No Content status.

    test-delete_image.PNG

    Response

    Here data mapping is not possible because of response has 204 No Content status.

    Theme

    • Create a Theme
    • Delete a Theme
    • Retrieve a Theme
    • Update a Theme

    Create a Theme

    Creates a new theme.

    URL

    First you can pass a URL and Method in the overview tab for create a theme. The required URL and method that must be included below :

    • Method : POST
    • Request URL : https://api.typeform.com/themes
    Parameters

    Add required parameters values for dynamically assigned in the API Call request. Set required Parameters must be included in parameters tab.

    • name - Name for the theme ( Required ).
    • answer - Color the theme will apply to answers, Allow hexadecimal value.
    • background - Color the theme will apply to the background, Allow hexadecimal value..
    • button - Color the theme will apply to buttons, Allow hexadecimal value.
    • question - Color the theme will apply to questions, Allow hexadecimal value.

    Headers

    There are 2 header Parameters must be included below. 

    • Authorization
    • Content-Type - application/json
    Request

    Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for creating a new theme. Here {answer}, {background}, {button}, {question}, {font} and {name} is assigned parameters that created in parameters tab.

    request_create_theme.PNG

    Test

    Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 201 status.

    Note: Here Authorization allow "bearer {your_access_token}".

    test_create_theme.PNG

    Response

    Built in responses already added are below. 

    • Id
    • Font
    • Name
    • Visibility
    • Question color code
    • Answer color code
    • Button color code
    • Background color code

    Update a Theme

    Updates a theme in your Typeform account. 

    Note: You can't change Typeform's public themes (the built-in themes that are available in all accounts).

    URL

    First you can pass a URL and Method in the overview tab for update a Theme. The required URL and method that must be included below :

    • Method :PUT
    • Request URL : https://api.typeform.com/themes/{theme_id}
    Parameters

    Set Parameters must be included in parameters tab.

    • theme_id - Theme Unique identifier( Required ).
    • name - Name for the theme ( Required ).
    • answer - Color the theme will apply to answers, Allow hexadecimal value.
    • background - Color the theme will apply to the background, Allow hexadecimal value..
    • button - Color the theme will apply to buttons, Allow hexadecimal value.
    • question - Color the theme will apply to questions, Allow hexadecimal value.
    Headers

    There are 2 header Parameters must be included below. 

    • Authorization
    • Content-Type - application/json
    Request

    Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for update a Theme. Here Here {answer}, {background}, {button}, {question}, {font} and {name} is assign parameter. here change all detail of theme. 

    request_update_theme.PNG

    Test

    Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

    test_update_theme.PNG

    Response

    Built in responses already added are below. 

    • Id
    • Font
    • Name
    • Visibility
    • Question color code
    • Answer color code
    • Button color code
    • Background color code

    Retrieve a Theme

    Retrieves a theme in your Typeform account.

    URL

    First you can pass a URL and Method in the overview tab for getting a details of theme. The required URL and method that must be included below :

    • Method : GET
    • Request URL : https://api.typeform.com/themes/{theme_id}
    Parameters

    Set Parameters must be included in parameters tab.

    • theme_id -  Theme unique identifier ( Required ).
    Headers

    There are 2 header Parameters must be included below. 

    • Authorization
    • Accept - application/json
    Test

    Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

    test_retrieve_theme.PNG

    Response

    Built in responses already added are below. 

    • Id
    • Font
    • Name
    • Visibility
    • Question color code
    • Answer color code
    • Button color code
    • Background color code

    Delete a Theme

    Deletes a theme from your Typeform account.

    URL

    First you can pass a URL and Method in the overview tab for delete theme. The required URL and method that must be included below :

    Parameters

    Set Parameters must be included in parameters tab.

    • theme_id -  Theme unique identifier ( Required ).
    Headers

    There are 2 header Parameters must be included below. 

    • Authorization
    • Content-Type - application/json
    Test

    Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 204 No Content status.

    test_delete_theme.PNGResponse

    Here data mapping is not possible because of response has 204 No Content status.

    Webhook

    • Create a Webhook
    • Retrieve a Single Webhook
    • Retrieve a Webhooks
    • Delete a Webhook

    Where do you want to send your typeform’s data? With our Webhooks API, you can send every submission straight to any URL or compatible web application as soon as it’s submitted.

    Create a Webhook

    Create or update a webhook.

    URL

    First you can pass a URL and Method in the overview tab for create or update a webhook. The required URL and method that must be included below :

    • Method :PUT
    • Request URL : https://api.typeform.com/forms/{form_id}/webhooks/{tag}
    Parameters

    Add required parameters values for dynamically assigned in the API Call request. Set required Parameters must be included in parameters tab.

    • form_id - Unique ID for the form.
    • tag - Unique name you want to use for the webhook.
    • url - Webhook URL which you set in the configuration panel.
    • enabled - True if you want to send responses to the webhook immediately. Otherwise, false.
    Headers

    There are 2 header Parameters must be included below. 

    • Authorization
    • Content-Type - application/json
    Request

    Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for creating or updating webhook . Here {url} and {enabled} is assigned parameters that created in parameters tab.

    request_create_webhook.PNG

    Test

    Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data. Successful response has 200 status.

    Note: Here Authorization allow "bearer {your_access_token}".

    Note: If you need to make a test URL – to collect test submissions – you can do this at https://requestbin.com.

    test_create_webhook.PNG

    Response

    Built in responses already added are below. 

    • Id
    • Form id
    • Tag
    • Url
    • Enabled
    • Verify ssl
    • Created at
    • Updated at

    Retrieve a Single Webhook 

    Retrieve a single webhook.

    URL

    First you can pass a URL and Method in the overview tab for getting a details of webhook. The required URL and method that must be included below :

    • Method : GET
    • Request URL : https://api.typeform.com/forms/{form_id}/webhooks/{tag}
    Parameters

    Set Parameters must be included in parameters tab.

    • form_id - Unique ID for the form.
    • tag - Unique name of the webhook.
    Headers

    There are 2 header Parameters must be included below. 

    • Authorization
    • Accept - application/json
    Test

    Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

    test_retrieve_single_webhook.PNG

    Response

    Built in responses already added are below. 

    • Id
    • Form id
    • Tag
    • Url
    • Enabled
    • Verify ssl
    • Created at
    • Updated at

    Retrieve a Webhooks 

    Retrieve all webhooks for the specified typeform.

    URL

    First you can pass a URL and Method in the overview tab for getting a list of webhooks. The required URL and method that must be included below :

    • Method : GET
    • Request URL : https://api.typeform.com/forms/{form_id}/webhooks
    Parameters

    Set Parameters must be included in parameters tab.

    • form_id - Unique ID for the form.
    Headers

    There are 2 header Parameters must be included below. 

    • Authorization
    • Accept - application/json
    Test

    Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 200 status.

    test_retrieve_webhook.PNG

    Response

    Here response is not set because of response have more then one webhooks. 

    Delete a Webhooks

    Delete a webhook.

    URL

    First you can pass a URL and Method in the overview tab for delete webhook. The required URL and method that must be included below :

    • Method :DELETE
    • Request URL : https://api.typeform.com/forms/{form_id}/webhooks/{tag}
    Parameters

    Set Parameters must be included in parameters tab.

    • form_id - Unique ID for the form.
    • tag - Unique name of the webhook.
    Headers

    There are 2 header Parameters must be included below. 

    • Authorization
    • Content-Type - application/json
    Test

    Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Successful response has 204 No Content status.

    test_delete_webhook.PNG

    Response

    Here data mapping is not possible because of response has 204 No Content status.

    Response

    • Retrieve a Response

    More Details

    To learn more about this Pipe and the additional API Methods, please see this article: https://developer.typeform.com/

    Back to top