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 the Typebot.io API, a self-hosted chatbot builder that uses visual flows to create chatbots ("typebots"). The node allows users to manage typebots, chat sessions, conversation results, and workspace settings within n8n workflows.

The "List Typebots" operation under the "Typebot" resource retrieves all typebots available in the user's workspace. This is useful for scenarios where you want to display, filter, or process multiple chatbots programmatically, such as generating reports, syncing chatbot data, or automating management tasks.

Practical example:
You might use this node to fetch all your chatbots in a workspace and then iterate over them to update their configurations, export their data, or trigger other workflow actions based on their status or folder organization.

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:
- Stream Enabled Boolean to enable streaming for real-time responses during chat operations (not used here).
- Prefilled Variables Variables to prefill in the typebot, each with a name and value (not used here).
- Result ID Existing result ID to continue a conversation (not used here).
- Theme Custom theme configuration as JSON (not used here).
- Settings Custom settings as JSON (not used here).
- Icon Typebot icon as emoji or URL (not used here).
- Typebot JSON Typebot configuration as JSON for import/update (not used here).
- Export Format Format for exporting results: CSV, JSON, or Excel (not used here).
- Filename Custom filename for file uploads (not used here).
- File Size Limit MB File size limit in megabytes for uploads (not used here).

For the "List Typebots" operation specifically, only the Folder ID property is relevant to filter the list of typebots.

Output

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

The exact structure depends on the Typebot API but typically includes properties like typebot ID, name, folder ID, icon, status, and other metadata.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Typebot API.
  • Needs the API base URL, API token, and workspace ID configured in the node credentials.
  • The node sends requests through a proxy service at https://n8ntools.io/api/v1/proxy/typebot using 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 problems can cause request failures.

  • Error messages:

    • "Unknown typebot operation: listTypebots" — indicates a misconfiguration of the operation parameter.
    • HTTP errors from the API (e.g., 401 Unauthorized) suggest credential or permission issues.
    • JSON parsing errors if invalid JSON is provided in other operations' fields (not applicable here).

  • Resolutions:

    • Verify API credentials and permissions.
    • Confirm workspace and folder IDs are correct.
    • Ensure network access to the proxy and Typebot API endpoints.

Links and References

Discussion