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 to manage and retrieve conversation results from chatbots built on the Typebot platform. Specifically, the "List Results" operation under the "Result" resource fetches all conversation results associated with a specified Typebot ID.

Use cases include:

  • Retrieving all user interaction results for analysis or reporting.
  • Monitoring chatbot performance by reviewing collected conversation data.
  • Feeding conversation results into other workflows for further processing or storage.

For example, you might use this node to list all conversations that users have had with a particular chatbot to analyze common questions or issues.

Properties

Name Meaning
Typebot ID The unique identifier of the Typebot whose results you want to list.
Additional Fields Optional extra parameters (not used in this operation).

Note: For the "List Results" operation, only the Typebot ID is required. The "Additional Fields" collection is available but does not affect this operation.

Output

The node outputs a JSON array containing the list of conversation results for the specified Typebot. Each item in the output corresponds to a single conversation result object as returned by the Typebot API.

The structure of each result object depends on the Typebot API's response format but typically includes details such as:

  • Result ID
  • Conversation metadata (timestamps, user info)
  • Interaction data (messages exchanged, variables captured)

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Typebot API.
  • The node uses the configured API URL and authentication token to communicate with the Typebot service.
  • No additional external dependencies are needed beyond the API credentials.

Troubleshooting

  • Common Issues:

    • Invalid or missing Typebot ID will cause the API request to fail.
    • Incorrect or expired API credentials will result in authorization errors.
    • Network connectivity problems can prevent successful API calls.

  • Error Messages:

    • "Unknown result operation: listResults": Indicates a misconfiguration of the operation parameter; ensure "List Results" is selected.
    • Authorization errors typically mention invalid tokens or lack of permission; verify API keys and tokens.
    • If the node returns an error JSON with a message, check the message for specific API error details.

  • Resolution Tips:

    • Double-check the Typebot ID input for correctness.
    • Confirm that the API key and token are valid and have necessary permissions.
    • Ensure the API URL is correctly set in the credentials.
    • Use the node's "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion