N8N Tools - Typebot API icon

N8N Tools - Typebot API

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

Actions23

Overview

This node provides a comprehensive integration with Typebot.io, a self-hosted chatbot builder that uses visual flows. It allows users to manage typebots (chatbots), chat sessions, conversation results, and workspace settings directly from n8n workflows.

The "Get Typebot" operation specifically retrieves detailed information about a particular typebot by its ID. This is useful when you want to fetch the current configuration or status of a chatbot for monitoring, auditing, or further processing in your automation.

Common scenarios:

  • Fetching a chatbot's details before updating or publishing it.
  • Retrieving chatbot metadata to display in dashboards or reports.
  • Validating the existence and properties of a chatbot before triggering other workflow steps.

Practical example:
You have multiple chatbots deployed for different customer support topics. Before sending a message or starting a chat session, you use this node to get the chatbot’s details to confirm it is active and configured correctly.

Properties

Name Meaning
Typebot ID The unique identifier of the typebot to retrieve. Required for operations like getting, updating, deleting, publishing, unpublishing, duplicating, starting chats, listing results, and exporting results.
Additional Fields A collection of optional fields that can be used to customize various operations. For "Get Typebot" specifically, these are generally not required but available for other operations.

Since the user requested only the "Get Typebot" operation under the "Typebot" resource, the main relevant property is:

  • Typebot ID: The ID of the typebot whose details you want to fetch.

Other properties listed in the input JSON pertain to other operations or resources and are not applicable here.

Output

The output is a JSON object containing the full details of the requested typebot as returned by the Typebot API. This includes all metadata and configuration data associated with the typebot.

Example structure (simplified):

{
  "id": "string",
  "name": "string",
  "icon": "string",
  "workspaceId": "string",
  "folderId": "string",
  "published": true,
  "createdAt": "timestamp",
  "updatedAt": "timestamp",
  "configuration": { /* typebot config JSON */ },
  ...
}

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Typebot API.
  • Needs the base URL of the Typebot API server.
  • Requires an API token for authorization.
  • Workspace ID must be configured or provided as part of credentials or parameters.

These credentials and configurations must be set up in n8n prior to using the node.

Troubleshooting

  • Error: Unknown typebot operation: getTypebot
    This indicates the operation parameter was not recognized. Ensure the operation is exactly "getTypebot".

  • Error: Missing Typebot ID
    The node requires a valid Typebot ID to fetch details. Verify that the ID is provided and correct.

  • Authentication errors
    If the API key or token is invalid or missing, the request will fail. Check that credentials are properly configured.

  • Network or API endpoint errors
    Confirm the API URL is reachable and correct. Also, ensure the Typebot server is running and accessible.

Links and References

Discussion