N8N Tools - Typebot API icon

N8N Tools - Typebot API

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

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.

Common scenarios where this node is beneficial include:

  • Retrieving the outcome of a particular chatbot interaction for analysis or reporting.
  • Accessing user responses or conversation metadata after a chat session has ended.
  • Integrating chatbot results into workflows for further processing, such as sending notifications or updating databases.

Practical example:

  • After a user completes a chatbot flow, use this node to get the conversation result by its ID, then extract user inputs or scores to trigger follow-up actions like sending personalized emails or updating CRM records.

Properties

Name Meaning
Result ID The unique identifier of the conversation result to retrieve.
Additional Fields Optional extra parameters including:
- Stream Enabled Enable streaming for real-time responses (boolean).
- Prefilled Variables Variables to prefill in the typebot before fetching the result; each variable has a name and value.
- 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 Full Typebot configuration as JSON (used for import/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 Maximum allowed file size in megabytes (number).

For the "Get Result" operation, the primary required property is Result ID.

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 Result ID, such as user responses, timestamps, and any metadata associated with that result.

If the operation involves exporting results (not applicable here), the output format can be CSV, JSON, or Excel depending on the selected export format.

No binary data output is indicated for 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 workspace ID is used internally to scope requests.
  • The node sends requests through a proxy service hosted at https://n8ntools.io/api/v1/proxy/typebot which requires an additional API key for that proxy.

Troubleshooting

  • Common issues:

    • Invalid or missing Result ID will cause the API to return errors indicating the result cannot be found.
    • Incorrect or expired API tokens will lead to authentication failures.
    • Network or proxy issues may prevent successful API calls.

  • Error messages:

    • "Unknown result operation": Indicates an unsupported operation was requested; ensure "getResult" is selected.
    • Authentication errors typically mention invalid credentials or unauthorized access.
    • JSON parsing errors may occur if custom JSON fields (like theme or settings) are malformed.

  • Resolutions:

    • Verify the Result ID is correct and exists in the Typebot system.
    • Check that API credentials are valid and have necessary permissions.
    • Validate any JSON input fields for proper syntax.
    • Ensure network connectivity and proxy API keys are correctly set.

Links and References

Discussion