Typeform

Build beautiful, engaging, and conversational online forms, surveys, quizzes, landing pages, and much more with Typeform.

Status: Preview

Tier: Standard

Version: 1.0.0

Actions:

Name	Summary
GetSchema (string form_id)	Get schema
ListForms ()	List forms
DeleteWebhook (string form_id, string tag)	Delete webhook
ListForms_V2 ([Optional]string search, [Optional]integer page, [Optional]integer page_size, [Optional]string workspace_id)	List forms
GetSchema_V2 (string form_id)	Get schema
GetSchema_V3 (string form_id)	Get schema
WebhookResponse ()
WebhookResponse_V2 ()

Triggers:

Name	Summary
TrigNewResponse (string form_id)	When a response is submitted
NewResponseWebhook (string form_id, string tag, NewResponseWebhookParameterBody body)	When a response is submitted
NewResponseWebhook_V2 (string form_id, string tag, NewResponseWebhook_V2ParameterBody body)	When a response is submitted

Objects:

Name	Summary
Item
ListFormsResponse
ListFormsResponseItem
NewResponseWebhookParameterBody
NewResponseWebhook_V2ParameterBody
ResponseList
WebhookCreationResponse

Actions:

GetSchema

Summary: Get schema

Description: Get schema

Syntax:

Typeform.GetSchema (string form_id)

Parameters:

Name

Type

Summary

Required

Related Action

form_id

string

(Form)

Form

True

ListForms

Returns:

Type:string

ListForms

Summary: List forms

Description: List forms

Syntax:

Typeform.ListForms ()

Returns:

Type:array of (ListFormsResponseItem)

DeleteWebhook

Summary: Delete webhook

Description: Deletes a webhook.

Syntax:

Typeform.DeleteWebhook (string form_id, string tag)

Parameters:

Name

Type

Summary

Required

Related Action

form_id

string

Unique ID of the form.

True

tag

string

Unique name you want to use for the webhook.

True

Returns:

Type:string

ListForms_V2

Summary: List forms

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

Syntax:

Typeform.ListForms_V2 ([Optional]string search, [Optional]integer page, [Optional]integer page_size, [Optional]string workspace_id)

Parameters:

Name	Type	Summary	Required	Related Action
search	string	Returns items that contain the specified string	False
page	integer	The page of results to retrieve. Default is the first page.	False
page_size	integer	Number of results to retrieve per page. Default is 10. Maximum is 200.	False
workspace_id	string	Retrieve typeforms for the specified workspace.	False

Returns:

Type:ListFormsResponse

GetSchema_V2

Summary: Get schema

Description: Get schema

Syntax:

Typeform.GetSchema_V2 (string form_id)

Parameters:

Name

Type

Summary

Required

Related Action

form_id

string

(Form)

Form

True

ListForms_V2

Returns:

Type:string

GetSchema_V3

Summary: Get schema

Description: Get schema

Syntax:

Typeform.GetSchema_V3 (string form_id)

Parameters:

Name

Type

Summary

Required

Related Action

form_id

string

(Form)

Form

True

ListForms_V2

Returns:

Type:string

WebhookResponse

Summary:

Description:

Syntax:

Typeform.WebhookResponse ()

Returns:

WebhookResponse_V2

Summary:

Description:

Syntax:

Typeform.WebhookResponse_V2 ()

Returns:

Triggers:

Trigger TrigNewResponse

Summary: When a response is submitted

Description: This operation triggers when a new response is submitted.

Syntax:

Typeform.TrigNewResponse (string form_id)

Parameters:

Name

Type

Summary

Required

Related Action

form_id

string

(Form)

Form

True

ListForms

Returns:

Type:ResponseList

Trigger NewResponseWebhook

Summary: When a response is submitted

Description: This operation triggers when a new response is submitted.

Syntax:

Typeform.NewResponseWebhook (string form_id, string tag, NewResponseWebhookParameterBody body)

Parameters:

Name	Type	Summary	Required	Related Action
form_id	string (Unique ID for the form.)	Unique ID for the form. Find in your form URL.	True	ListForms_V2
tag	string (Unique name to identify the webhook)	Unique name you want to use for the webhook.	True
body	NewResponseWebhookParameterBody		True

Returns:

Type:WebhookCreationResponse

Description: A JSON that contains information on the newly created webhook

Trigger NewResponseWebhook_V2

Summary: When a response is submitted

Description: This operation triggers when a new response to the form is submitted.

Syntax:

Typeform.NewResponseWebhook_V2 (string form_id, string tag, NewResponseWebhook_V2ParameterBody body)

Parameters:

Name	Type	Summary	Required	Related Action
form_id	string (Select a form)	Select a form from the dropdown.	True	ListForms_V2
tag	string (Specify a tag for the webhook)	Unique name you want to use for the webhook.	True
body	NewResponseWebhook_V2ParameterBody		True

Returns:

Type:WebhookCreationResponse

Description: A JSON that contains information on the newly created webhook

Item

Summary:

Description:

Properties:

Name

Type

Summary

ItemInternalId

string

ListFormsResponse

Summary:

Description:

Properties:

Name	Type	Summary
total_items	integer(int32)	Total number of forms.
page_count	integer(int32)	Number of pages of results.
items	array of (ItemsItem)	Forms in response.

ItemsItem

Summary:

Description:

Properties:

Name	Type	Summary
id	string	Unique form ID.
title	string	Form title.
last_updated_at	string(date-time)	Date and time the typeform was last updated. In ISO 8601 format, Coordinated Universal Time (UTC), to the second.
self	Self	Typeform.
theme	Theme	Typeform theme.
_links	_links	Typeform links.

Self

Summary:

Description: Typeform.

Properties:

Name

Type

Summary

href

string

URL to the typeform.

Theme

Summary:

Description: Typeform theme.

Properties:

Name

Type

Summary

href

string

URL to the typeform's theme.

_links

Summary:

Description: Typeform links.

Properties:

Name

Type

Summary

display

string

Display URL.

ListFormsResponseItem

Summary:

Description:

Properties:

Name

Type

Summary

string

Form Id

Unique identifier of a form.

name

string

Form Name

Name of the Typeform.

NewResponseWebhookParameterBody

Summary:

Description:

Properties:

Name

Type

Summary

url

string

Webhook URL.

enabled

boolean

Enabled

Yes if you want to send responses to the webhook immediately. Otherwise, no.

NewResponseWebhook_V2ParameterBody

Summary:

Description:

Properties:

Name

Type

Summary

url

string

Webhook URL.

enabled

boolean

Enabled

Yes if you want to send responses to the webhook immediately. Otherwise, no.

ResponseList

Summary:

Description:

Properties:

Name

Type

Summary

responses

array of (Item)

WebhookCreationResponse

Summary:

Description: A JSON that contains information on the newly created webhook

Properties:

Name	Type	Summary
id	string	Unique ID of the webhook
form_id	string	Unique ID of the typeform
tag	string	Unique name you want to use for the webhook
url	string	Webhook URL
enabled	boolean	True if you want to send responses to the webhook immediately. Otherwise, false.
created_at	string(date-time)	Date and time when webhook was created. In ISO 8601 format, UTC time, to the second, with T as a delimiter between the date and time.
updated_at	string(date-time)	Date of last update to webhook. In ISO 8601 format, UTC time, to the second, with T as a delimeter between the date and time.