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 provides a comprehensive integration with Typebot.io, a self-hosted chatbot builder that uses visual flows to create chatbots. 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 before performing further actions such as updates, publishing, or analytics.

Common scenarios:

  • Fetching a chatbot's details to display or log its configuration.
  • Validating the existence or properties of a chatbot before updating it.
  • Integrating chatbot metadata into other systems or dashboards.

Practical example:
You have multiple chatbots deployed for different products. Before sending a message or updating a chatbot, 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 details for.
Additional Fields A collection of optional fields that can be used with various operations but not required here.

Since the "Get Typebot" operation only requires the Typebot ID, the additional fields are not applicable for this operation.

Output

The output is a JSON object containing the detailed information of the requested typebot. This typically includes all configuration data, metadata, and status related to the chatbot.

Example structure (simplified):

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

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Typebot.io API.
  • Needs the base URL of the Typebot API and an authentication token.
  • Workspace ID must be configured in credentials to scope requests properly.
  • The node sends HTTP requests to the Typebot API endpoints.

Troubleshooting

  • Error: Unknown typebot operation: getTypebot
    This indicates a misconfiguration of the operation parameter. Ensure the operation is set exactly to "getTypebot".

  • Authentication errors (e.g., 401 Unauthorized)
    Verify that the API key and token credentials are correct and have sufficient permissions.

  • 404 Not Found for the given Typebot ID
    Confirm that the provided Typebot ID exists and belongs to the configured workspace.

  • Network or timeout issues
    Check network connectivity to the Typebot API endpoint and ensure the base URL is correct.

Links and References

Discussion