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 for chatbots built with Typebot. The "List Results" operation under the "Result" resource fetches all conversation results associated with a specified Typebot ID.

Use cases include:

  • Retrieving analytics or logs of user interactions with a chatbot.
  • Monitoring chatbot performance by listing all conversation outcomes.
  • Exporting or processing conversation data for further analysis or reporting.

For example, you might use this node to get all conversation results from a particular chatbot to analyze user engagement or troubleshoot issues in conversations.

Properties

Name Meaning
Typebot ID The unique identifier of the Typebot whose results you want to list.
Additional Fields Optional extra parameters (not used directly in "List Results" but available for other ops).

Note: For the "List Results" operation, only the Typebot ID is required. The "Additional Fields" collection includes various optional fields used in other operations but are not applicable here.

Output

The output is a JSON object containing the list of conversation results retrieved from the Typebot API for the specified Typebot ID.

  • The json field contains the raw response from the API, which typically includes an array of result objects representing individual conversation sessions or interactions.
  • Each result object may contain details such as timestamps, user inputs, chatbot responses, metadata, and identifiers.
  • No binary data is output by this operation.

Example output structure (simplified):

{
  "results": [
    {
      "id": "result1",
      "createdAt": "2024-01-01T12:00:00Z",
      "conversationData": { /* conversation details */ },
      ...
    },
    {
      "id": "result2",
      "createdAt": "2024-01-02T15:30:00Z",
      "conversationData": { /* conversation details */ },
      ...
    }
  ]
}

Dependencies

  • Requires an API key credential for authenticating with the Typebot API.
  • Needs configuration of the Typebot API base URL and authentication token within n8n credentials.
  • The node sends requests through a proxy service at https://n8ntools.io/api/v1/proxy/typebot using an additional API key for that proxy.

Troubleshooting

  • Common Issues:

    • Invalid or missing Typebot ID will cause the API call 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: <operation>": Indicates an unsupported operation was requested; ensure "listResults" is selected.
    • Authorization errors usually 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 hints about missing parameters or invalid values.

  • Resolutions:

    • Double-check the Typebot ID input.
    • Verify that the API key and token credentials are correctly set up and valid.
    • Ensure network access to the proxy endpoint and Typebot API is allowed.

Links and References

Discussion