Typeform

Typeform module for RobinPath.

Package: @robinpath/typeform | Category: Utility | Type: Utility

Authentication

typeform.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the typeform module when you need to:

• listForms -- Use typeform.listForms to perform this operation
• getForm -- Use typeform.getForm to perform this operation
• createForm -- Use typeform.createForm to perform this operation
• updateForm -- Use typeform.updateForm to perform this operation
• deleteForm -- Use typeform.deleteForm to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure typeform credentials.	object
listForms	listForms	object
getForm	getForm	object
createForm	createForm	object
updateForm	updateForm	object
deleteForm	deleteForm	object
listResponses	listResponses	object
getResponse	getResponse	object
deleteResponse	deleteResponse	object
listWorkspaces	listWorkspaces	object
getWorkspace	getWorkspace	object
createWorkspace	createWorkspace	object
listThemes	listThemes	object
getInsights	getInsights	object
getFormAnalytics	getFormAnalytics	object

Functions

setCredentials

Configure typeform credentials.

Module: typeform | Returns: object -- API response.

typeform.setCredentials

Parameter	Type	Required	Description
accessToken	string	Yes	accessToken

---

listForms

listForms

Module: typeform | Returns: object -- API response.

typeform.listForms

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getForm

getForm

Module: typeform | Returns: object -- API response.

typeform.getForm

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createForm

createForm

Module: typeform | Returns: object -- API response.

typeform.createForm

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateForm

updateForm

Module: typeform | Returns: object -- API response.

typeform.updateForm

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteForm

deleteForm

Module: typeform | Returns: object -- API response.

typeform.deleteForm

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listResponses

listResponses

Module: typeform | Returns: object -- API response.

typeform.listResponses

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getResponse

getResponse

Module: typeform | Returns: object -- API response.

typeform.getResponse

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteResponse

deleteResponse

Module: typeform | Returns: object -- API response.

typeform.deleteResponse

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listWorkspaces

listWorkspaces

Module: typeform | Returns: object -- API response.

typeform.listWorkspaces

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getWorkspace

getWorkspace

Module: typeform | Returns: object -- API response.

typeform.getWorkspace

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createWorkspace

createWorkspace

Module: typeform | Returns: object -- API response.

typeform.createWorkspace

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listThemes

listThemes

Module: typeform | Returns: object -- API response.

typeform.listThemes

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getInsights

getInsights

Module: typeform | Returns: object -- API response.

typeform.getInsights

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getFormAnalytics

getFormAnalytics

Module: typeform | Returns: object -- API response.

typeform.getFormAnalytics

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Typeform API error (${res.status}): ${t}	Check the error message for details
typeform.setCredentials requires accessToken.	Check the error message for details
typeform.updateForm requires an ID.	Check the error message for details
typeform.deleteForm requires an ID.	Check the error message for details
typeform.deleteResponse requires an ID.	Check the error message for details
Typeform: "..." not configured. Call typeform.setCredentials first.	Check the error message for details

@desc "List forms and validate result"
do
  set $result as typeform.listForms
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Forms

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  typeform.setCredentials $token
enddo

@desc "List forms and iterate results"
do
  set $result as typeform.listForms
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createForm

Create a new resource and capture the result.

@desc "Setup authentication"
do
  typeform.setCredentials $token
enddo

@desc "Create form"
do
  set $result as typeform.createForm
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  typeform.setCredentials $token
enddo

@desc "Create form and update form"
do
  set $created as typeform.createForm
  # Update the created item
  typeform.updateForm
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  typeform.setCredentials $token
enddo

@desc "List forms and create form"
do
  set $existing as typeform.listForms
  if $existing == null
    typeform.createForm
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Typeform workflow

Chain multiple typeform operations together.

@desc "Setup authentication"
do
  typeform.setCredentials $token
enddo

@desc "List forms, get form, and more"
do
  set $r_listForms as typeform.listForms
  set $r_getForm as typeform.getForm
  set $r_createForm as typeform.createForm
  print "All operations complete"
enddo

6. Safe listForms with validation

Check results before proceeding.

@desc "Setup authentication"
do
  typeform.setCredentials $token
enddo

@desc "List forms and validate result"
do
  set $result as typeform.listForms
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• json -- JSON module for complementary functionality