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, enabling users to manage and interact with Typebot chatbots programmatically within n8n workflows. Specifically, the "Create Typebot" operation allows users to create a new chatbot (typebot) in their workspace, optionally organizing it into folders and customizing its appearance and behavior.

Common scenarios where this node is beneficial include:

  • Automating the creation of chatbots as part of a deployment or content update pipeline.
  • Programmatically managing multiple chatbots across different projects or teams.
  • Integrating chatbot creation into broader automation workflows that involve user engagement or customer support.

Practical example:

  • A marketing team can automatically create a new chatbot for each campaign by providing a name and optional folder ID, along with custom icons and settings, streamlining chatbot deployment without manual intervention.

Properties

Name Meaning
Typebot Name The name to assign to the new typebot (chatbot).
Folder ID Optional identifier to place the new typebot inside a specific folder for organization.
Additional Fields Collection of optional fields to customize the typebot:
- Stream Enabled Enable streaming mode for real-time responses (boolean).
- Prefilled Variables Variables to prefill in the typebot; each variable has a name and value pair.
- Result ID Existing conversation result ID to continue a previous conversation (string).
- Theme JSON object defining custom theme configuration for the typebot.
- Settings JSON object containing custom settings for the typebot.
- Icon Icon for the typebot, either an emoji or a URL string.
- Typebot JSON JSON configuration representing the full typebot setup, useful for import or update operations.
- Export Format Format for exporting results (CSV, JSON, Excel); not directly relevant for creation but available in additional fields.
- Filename Custom filename for file uploads; not directly relevant for creation.
- File Size Limit MB Maximum allowed file size in megabytes for uploads; not directly relevant for creation.

Output

The node outputs a JSON object representing the response from the Typebot API after creating the typebot. This typically includes details about the newly created typebot such as its unique ID, name, workspace association, icon, and other metadata returned by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "workspaceId": "string",
  "folderId": "string",
  "icon": "string",
  "createdAt": "string",
  "updatedAt": "string",
  ...
}

Dependencies

  • Requires an API key credential for authenticating with the Typebot.io API.
  • Needs configuration of the API base URL and authentication token within the node credentials.
  • The node uses an external proxy service (https://n8ntools.io/api/v1/proxy/typebot) to forward requests to the Typebot API.
  • Workspace ID must be set in credentials to associate the new typebot with the correct workspace.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing malformed JSON in fields like theme, settings, or typebotJson will result in parsing errors.
    • Omitting required parameters such as Typebot Name will trigger validation errors.
    • Network connectivity problems may prevent successful API calls.

  • Error messages:

    • "Unknown typebot operation: createTypebot" indicates a misconfiguration of the operation parameter.
    • Authentication errors typically mention unauthorized access or invalid tokens.
    • JSON parsing errors occur if JSON fields are not properly formatted.

  • Resolutions:

    • Ensure all required credentials and parameters are correctly set.
    • Validate JSON inputs before running the workflow.
    • Check network connectivity and API endpoint accessibility.
    • Use the node's "Continue On Fail" option to handle errors gracefully in bulk operations.

Links and References

Discussion