> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/typeform.md).

# Typeform

Typeform is a form builder platform that enables you to create interactive forms, surveys, and quizzes.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Typeform  | OAuth sign-in  |

### Typeform

Connect to Typeform to access form submissions, create forms, and manage form data.

#### Set up in Typeform

1. Review the requested scopes (form and response access) and click Accept/Authorize to grant access.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Typeform**.
2. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

StackAI obtains the OAuth credentials during sign-in. You do not need to paste an access token or refresh token.

**Provider documentation:** [Setup reference](https://www.typeform.com/developers/get-started/applications/).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Detailed setup guides

* [Connect Typeform](https://docs.stackai.com/integrations/catalog/typeform/connect-typeform.md)

## Use an action

1. Add the required **Typeform** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Retrieve Account Workspaces

Retrieve account workspaces

#### Inputs

| Field      | Type   | Required | Description                                                              |
| ---------- | ------ | -------- | ------------------------------------------------------------------------ |
| Account Id | string | Yes      |                                                                          |
| Search     | string | No       | Returns items that contain the specified string.                         |
| Page       | string | No       | The page of results to retrieve. Default 1 is the first page of results. |
| Page Size  | string | No       | Number of results to retrieve per page. Default is 10. Maximum is 200.   |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Forms

Retrieve forms

#### Inputs

| Field        | Type   | Required | Description                                                              |
| ------------ | ------ | -------- | ------------------------------------------------------------------------ |
| Search       | string | No       | Returns items that contain the specified string.                         |
| Page         | string | No       | The page of results to retrieve. Default 1 is the first page of results. |
| Page Size    | string | No       | Number of results to retrieve per page. Default is 10. Maximum is 200.   |
| Workspace Id | string | No       | Retrieve typeforms for the specified workspace.                          |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Delete Form

Delete form

#### Inputs

| Field   | Type   | Required | Description                                                                                                                              |
| ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id | string | Yes      | Unique 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. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Form

Retrieve form

#### Inputs

| Field   | Type   | Required | Description                                                                                                                              |
| ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id | string | Yes      | Unique 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. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Update Form (Patch)

Update form (patch)

#### Inputs

| Field   | Type   | Required | Description                                                                                                                              |
| ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id | string | Yes      | Unique 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. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Update Form

Update form

#### Inputs

| Field   | Type   | Required | Description                                                                                                                              |
| ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id | string | Yes      | Unique 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. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Custom Form Messages

Retrieve custom form messages

#### Inputs

| Field   | Type   | Required | Description                                                                                                                              |
| ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id | string | Yes      | Unique 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. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Update Custom Messages

Update custom messages

#### Inputs

| Field   | Type   | Required | Description                                                                                                                              |
| ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id | string | Yes      | Unique 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. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Delete Responses

Delete responses

#### Inputs

| Field                 | Type   | Required | Description                                                                                                                              |
| --------------------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id               | string | Yes      | Unique 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. |
| Included Response Ids | string | No       | Comma-separated list of response\_id values of the responses to delete. You can list up to 1000 tokens.                                  |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Responses

Retrieve responses

#### Inputs

| Field                 | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                     |
| --------------------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id               | string | Yes      | Unique 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.                                                                                                                                                                                                                        |
| Page Size             | string | No       | Maximum number of responses. Default value is 25. Maximum value is 1000. If your typeform has fewer than 1000 responses, you can retrieve all of the responses in a single request by adding the page\_size parameter. If your typeform has more than 1000 responses, use the since/until or before/after query parameters to narrow the scope of your request. |
| Since                 | string | No       | Limit request to responses submitted since the specified date and time. Could be passed as int (timestamp in seconds) or in ISO 8601 format, UTC time, to the second, with T as a delimiter between the date and time (2020-03-20T14:00:59).                                                                                                                    |
| Until                 | string | No       | Limit request to responses submitted until the specified date and time. Could be passed as int (timestamp in seconds) or in ISO 8601 format, UTC time, to the second, with T as a delimiter between the date and time (2020-03-20T14:00:59).                                                                                                                    |
| After                 | string | No       | Limit request to responses submitted after the specified token. Could not be used together with sort parameter, as it sorts responses in the order that our system processed them (submitted\_at). This ensures that you can traverse the complete set of responses without repeating entries.                                                                  |
| Before                | string | No       | Limit request to responses submitted before the specified token. Could not be used together with sort parameter, as it sorts responses in the order that our system processed them (submitted\_at). This ensures that you can traverse the complete set of responses without repeating entries.                                                                 |
| Included Response Ids | string | No       | Limit request to the specified responseid values. Use a comma-separated list to specify more than one responseid value.                                                                                                                                                                                                                                         |
| Excluded Response Ids | string | No       | Comma-separated list of response\_ids to be excluded from the response.                                                                                                                                                                                                                                                                                         |
| Completed             | string | No       | Limit responses only to those which were submitted. This parameter changes since/until filter, so if completed=true, it will filter by submittedat, otherwise - landedat.                                                                                                                                                                                       |
| Sort                  | string | No       | Responses order in {fieldID},{asc\|desc} format. You can use built-in submittedat/landedat field IDs or any field ID from your typeform, possible directions are asc/desc. Default value is submitted\_at,desc.                                                                                                                                                 |
| Query                 | string | No       | Limit request to only responses that include the specified string. The string will be escaped and it will be matched aganist all answers fields, hidden fields and variables values.                                                                                                                                                                            |
| Fields                | string | No       | Show only specified fields in answers section. If response does not have answers for specified fields, there will be null. Use a comma-separated list to specify more than one field value.                                                                                                                                                                     |
| Answered Fields       | string | No       | Limit request to only responses that include the specified fields in answers section. Use a comma-separated list to specify more than one field value - response will contain at least one of the specified fields.                                                                                                                                             |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Response File

Retrieve response file

#### Inputs

| Field       | Type   | Required | Description                                                                                                                              |
| ----------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id     | string | Yes      | Unique 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. |
| Response Id | string | Yes      | Unique ID for the response.                                                                                                              |
| Field Id    | string | Yes      | Unique ID for the file upload field.                                                                                                     |
| Filename    | string | Yes      | filename for the uploaded file.                                                                                                          |
| Inline      | string | No       | Request a file with HTTP header Content-Disposition: inline. Possible values: true, false. Default: false.                               |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Webhooks

Retrieve webhooks

#### Inputs

| Field   | Type   | Required | Description                                                                                                                              |
| ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id | string | Yes      | Unique 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. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Delete Webhook

Delete webhook

#### Inputs

| Field   | Type   | Required | Description                                                                                                                              |
| ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id | string | Yes      | Unique 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. |
| Tag     | string | Yes      | Unique name you want to use for the webhook.                                                                                             |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Single Webhook

Retrieve single webhook

#### Inputs

| Field   | Type   | Required | Description                                                                                                                              |
| ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id | string | Yes      | Unique 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. |
| Tag     | string | Yes      | Unique name you want to use for the webhook.                                                                                             |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Images Collection

Retrieve images collection

#### Inputs

No input fields are required in this catalog entry.

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Delete Image

Delete image

#### Inputs

| Field    | Type   | Required | Description                          |
| -------- | ------ | -------- | ------------------------------------ |
| Image Id | string | Yes      | Unique ID for the image to retrieve. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Image

Retrieve image

#### Inputs

| Field    | Type   | Required | Description                          |
| -------- | ------ | -------- | ------------------------------------ |
| Image Id | string | Yes      | Unique ID for the image to retrieve. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Background By Size

Retrieve background by size

#### Inputs

| Field    | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| -------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Image Id | string | Yes      | Unique ID for the image to retrieve.                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Size     | string | Yes      | Image size to retrieve. default is scaled to fit within a width of 1680px and a height of 1050px. tablet is scaled to fit within a width of 1024px and a height of 768px. mobile is scaled to fit within a width of 460px and a height of 320px. thumbnail is scaled to fit within a width of 80px and a height of 50px. NOTE: Images used for typeform backgrounds are scaled and cropped from a top-left alignment to make sure they fill the screen properly. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Choice Image By Size

Retrieve choice image by size

#### Inputs

| Field    | Type   | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| -------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Image Id | string | Yes      | Unique ID for the image to retrieve.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Size     | string | Yes      | Image size to retrieve. default is scaled to fit within a width of 230px and a height of 230px. thumbnail is scaled so that the smallest image side equals the largest of either 80px wide or 80px in height and then cropped. supersize is scaled so that the smallest image side equals the largest of either 310px wide or 233px in height and then cropped. supermobile is scaled so that the smallest image side equals the largest of either 238px wide or 164px in height and then cropped. supersizefit is scaled to fit within a width of 310px and a height of 233px. supermobilefit is scaled to fit within a width of 238px and a height of 164px. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Image By Size

Retrieve image by size

#### Inputs

| Field    | Type   | Required | Description                                                                                                                                                                                                                         |
| -------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Image Id | string | Yes      | Unique ID for the image to retrieve.                                                                                                                                                                                                |
| Size     | string | Yes      | Image size to retrieve. default is scaled to a width of 800px. mobile is scaled to a width of 460px. thumbnail is scaled so that the smallest image side equals the largest of either 80px wide or 50px in height and then cropped. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Form Insights

Retrieve Form Insights

#### Inputs

| Field   | Type   | Required | Description                                                                                                                              |
| ------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Form Id | string | Yes      | Unique 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. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Your Own User

Retrieve your own user

#### Inputs

No input fields are required in this catalog entry.

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### (Rtbf) Delete Responses

(RTBF) Delete responses

#### Inputs

| Field      | Type   | Required | Description |
| ---------- | ------ | -------- | ----------- |
| Account Id | string | Yes      |             |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Themes

Retrieve themes

#### Inputs

| Field     | Type   | Required | Description                                                              |
| --------- | ------ | -------- | ------------------------------------------------------------------------ |
| Page      | string | No       | The page of results to retrieve. Default 1 is the first page of results. |
| Page Size | string | No       | Number of results to retrieve per page. Default is 10. Maximum is 200.   |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Delete Theme

Delete theme

#### Inputs

| Field    | Type   | Required | Description              |
| -------- | ------ | -------- | ------------------------ |
| Theme Id | string | Yes      | Unique ID for the theme. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Theme

Retrieve theme

#### Inputs

| Field    | Type   | Required | Description              |
| -------- | ------ | -------- | ------------------------ |
| Theme Id | string | Yes      | Unique ID for the theme. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Update Theme

Update theme

#### Inputs

| Field    | Type   | Required | Description              |
| -------- | ------ | -------- | ------------------------ |
| Theme Id | string | Yes      | Unique ID for the theme. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Workspaces

Retrieve workspaces

#### Inputs

| Field     | Type   | Required | Description                                                              |
| --------- | ------ | -------- | ------------------------------------------------------------------------ |
| Search    | string | No       | Returns items that contain the specified string.                         |
| Page      | string | No       | The page of results to retrieve. Default 1 is the first page of results. |
| Page Size | string | No       | Number of results to retrieve per page. Default is 10. Maximum is 200.   |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Delete Workspace

Delete workspace

#### Inputs

| Field        | Type   | Required | Description                  |
| ------------ | ------ | -------- | ---------------------------- |
| Workspace Id | string | Yes      | Unique ID for the workspace. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Retrieve Workspace

Retrieve workspace

#### Inputs

| Field        | Type   | Required | Description                  |
| ------------ | ------ | -------- | ---------------------------- |
| Workspace Id | string | Yes      | Unique ID for the workspace. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Update Workspace

Update workspace

#### Inputs

| Field        | Type   | Required | Description                  |
| ------------ | ------ | -------- | ---------------------------- |
| Workspace Id | string | Yes      | Unique ID for the workspace. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### On Form Submission

Trigger a workflow execution every time a form is submitted.

#### Configuration

| Field   | Type            | Required | Description                                                                           |
| ------- | --------------- | -------- | ------------------------------------------------------------------------------------- |
| Form ID | select (string) | Yes      | The ID of the Typeform form to trigger on. Options load from the selected connection. |

#### Event inputs

| Field                | Type     | Required | Description                                                               |
| -------------------- | -------- | -------- | ------------------------------------------------------------------------- |
| Sample Form Response | textarea | Yes      | A JSON string representing a sample of the response of the Typeform form. |

#### Outputs

| Field         | Type   | Description                                                   |
| ------------- | ------ | ------------------------------------------------------------- |
| Form Response | string | A JSON string representing the response of the Typeform form. |

## Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/typeform.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
