N8N Tools - Typebot API icon

N8N Tools - Typebot API

Complete Typebot.io integration - Self-hosted chatbot builder with visual flows

Actions23

Overview

This node integrates with the Typebot.io API, specifically focusing on managing and retrieving conversation results when using the "Result" resource with the "Get Result" operation. It allows users to fetch detailed data about a specific conversation result from a Typebot chatbot session.

Typical use cases include:

  • Retrieving the outcome of a particular chatbot interaction for analysis or reporting.
  • Accessing user responses or conversation metadata stored in a Typebot result.
  • Integrating chatbot conversation data into workflows for further processing or decision-making.

For example, after a user completes a chat session with a Typebot chatbot, this node can be used to fetch that session's result by its ID, enabling automated follow-up actions such as sending personalized emails or updating CRM records.

Properties

Name Meaning
Result ID The unique identifier of the conversation result to retrieve.
Additional Fields A collection of optional parameters to customize the request:
- Stream Enabled Enable streaming for real-time responses (boolean).
- Prefilled Variables Variables to prefill in the typebot, each with a name and value (multiple entries allowed).
- Result ID An existing result ID to continue a conversation (string).
- Theme Custom theme configuration provided as JSON.
- Settings Custom settings provided as JSON.
- Icon Typebot icon specified as an emoji or URL string.
- Typebot JSON Typebot configuration as JSON for import or update operations.
- Export Format Format for exporting results; options are CSV, JSON, or Excel.
- Filename Custom filename for file uploads (string).
- File Size Limit MB File size limit in megabytes for uploads (number).

Note: For the "Get Result" operation, only the "Result ID" is required. Other additional fields are available but not typically used in this operation.

Output

The node outputs a JSON object containing the retrieved conversation result data from the Typebot API. This includes all details related to the specific conversation identified by the given Result ID, such as user inputs, timestamps, and any metadata associated with that conversation.

The output structure is:

{
  "json": {
    // Full JSON response from the Typebot API for the requested result
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Typebot API.
  • Needs the Typebot API base URL and an API token configured in the node credentials.
  • The node sends requests through a proxy service hosted at https://n8ntools.io/api/v1/proxy/typebot which requires an additional API key for access.

Troubleshooting

  • Common issues:

    • Invalid or missing Result ID will cause the API to return an error indicating the result was not found.
    • Incorrect or expired API tokens will lead to authentication failures.
    • Network connectivity problems may prevent successful API calls.

  • Error messages:

    • "Unknown result operation": Indicates an unsupported operation was selected; ensure "getResult" is chosen.
    • API errors returned from Typebot will be included in the node output if "Continue On Fail" is enabled.

  • Resolutions:

    • Verify the Result ID is correct and corresponds to an existing conversation.
    • Check that API credentials are valid and have necessary permissions.
    • Ensure network access to both the Typebot API and the proxy endpoint is available.

Links and References

Discussion