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, a self-hosted chatbot builder that uses visual flows to create chatbots ("typebots"). The node allows users to manage typebots within their workspace, including listing all typebots, creating new ones, updating, deleting, publishing/unpublishing, duplicating, and importing typebots from JSON configurations.

The "List Typebots" operation specifically retrieves all typebots available in the user's workspace, optionally filtered by a folder ID. This is useful for scenarios where you want to programmatically fetch and display all chatbots you have access to, organize them by folders, or use the list as input for further automation workflows such as batch updates or analytics.

Practical examples:

  • Automatically retrieve all typebots in a workspace to generate a dashboard overview.
  • Filter typebots by folder to process only those related to a specific project.
  • Use the list of typebots to trigger notifications or audits on chatbot configurations.

Properties

Name Meaning
Folder ID Optional string to filter or organize typebots by a specific folder ID.
Additional Fields A collection of optional fields to customize the request or behavior. Includes:
- Stream Enabled Boolean flag to enable streaming for real-time responses (used in chat operations).
- Prefilled Variables List of variables (name-value pairs) to prefill in the typebot (used in chat operations).
- Result ID String ID of an existing result to continue a conversation (used in chat operations).
- Theme JSON object defining custom theme configuration for the typebot.
- Settings JSON object for custom settings configuration.
- Icon String representing the typebot icon, either an emoji or URL.
- Typebot JSON JSON object containing the full typebot configuration, used for import or update operations.
- Export Format Option to select export format for results: CSV, JSON, or Excel (used in result export).
- Filename Custom filename for file uploads (used in chat upload URL generation).
- File Size Limit MB Number specifying the file size limit in megabytes (used in chat upload URL generation).

For the "List Typebots" operation, only the Folder ID property is relevant as a filter.

Output

The output is an array of JSON objects representing the response from the Typebot API endpoint /api/v1/typebots. Each item corresponds to a typebot in the workspace and includes its details as returned by the API.

The exact structure depends on the Typebot API but typically includes fields like:

  • Typebot ID
  • Name
  • Icon
  • Folder ID
  • Status (published/unpublished)
  • Other metadata related to the chatbot

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Typebot API.
  • Needs the base API URL and an API token configured in the node credentials.
  • Workspace ID is required to scope the requests properly.
  • 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 API credentials will cause authentication errors.
    • Incorrect workspace ID or folder ID may result in empty lists or errors.
    • Network connectivity issues to the proxy or Typebot API endpoints.
  • Error messages:
    • "Unknown typebot operation": Indicates an unsupported operation was selected; verify the operation name.
    • "Unknown resource": Means the resource parameter is invalid or not supported.
    • HTTP errors from the API (e.g., 401 Unauthorized, 404 Not Found) usually indicate credential or parameter issues.
  • Resolutions:
    • Ensure API keys and tokens are correctly set up in n8n credentials.
    • Verify workspace and folder IDs exist and are accessible.
    • Check network connectivity and proxy service availability.

Links and References

Discussion