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 Typebot.io, a self-hosted chatbot builder platform that allows creating and managing chatbots with visual flow design. The "Create Typebot" operation specifically enables users to create a new chatbot (typebot) within their workspace on Typebot.io.

Typical use cases include:

  • Automating the creation of chatbots as part of a workflow.
  • Organizing chatbots into folders for better management.
  • Setting initial properties such as name, icon, theme, and prefilled variables during creation.

For example, a marketing team could automate the deployment of new customer support bots by specifying the bot's name, folder, and configuration through this node.

Properties

Name Meaning
Typebot Name The name to assign to the new typebot (chatbot).
Folder ID Optional identifier of a folder to organize or filter the typebot within the workspace.
Additional Fields A collection of optional settings including:
- Stream Enabled Enable streaming mode for real-time responses from the chatbot (boolean).
- Prefilled Variables Variables to prefill in the typebot; each variable has a name and value pair.
- Result ID An existing conversation result ID to continue a previous conversation.
- Theme JSON object defining custom theme configurations for the typebot.
- Settings JSON object for additional custom settings of the typebot.
- Icon Icon representing the typebot, can be an emoji or URL string.
- Typebot JSON JSON configuration of the typebot, useful for import or update operations.
- Export Format Format for exporting results (CSV, JSON, Excel) — not directly relevant for creation but available.
- Filename Custom filename for file uploads related to the typebot.
- File Size Limit MB Maximum allowed file size in megabytes for uploads.

Output

The node outputs a JSON object containing the response from the Typebot API after attempting to create the typebot. This typically includes details about the newly created typebot such as its ID, name, workspace association, and any other metadata returned by the API.

No binary data output is involved in this operation.

Example output structure (simplified):

{
  "id": "string",
  "name": "string",
  "workspaceId": "string",
  "folderId": "string",
  "icon": "string",
  "theme": {},
  "settings": {},
  ...
}

Dependencies

  • Requires an API key credential for authenticating with the Typebot.io API.
  • Needs the base API URL and an authentication token configured in the node credentials.
  • Workspace ID is required and retrieved from credentials to associate the new typebot correctly.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing malformed JSON in fields like Theme, Settings, or Typebot JSON will cause parsing errors.
    • Specifying a non-existent folder ID may lead to errors or the typebot being created outside intended organization.

  • Error messages:

    • "Unknown typebot operation": Indicates an unsupported operation was selected; ensure "createTypebot" is chosen.
    • API errors related to authorization or validation will be returned in the node output JSON under an error field if "Continue On Fail" is enabled.

  • Resolutions:

    • Verify API credentials and permissions.
    • Validate JSON inputs before passing them to the node.
    • Confirm folder IDs exist in the workspace.

Links and References

Discussion