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 platform that allows users to create and manage chatbots with visual flow design. The node supports various operations on Typebot resources such as managing typebots (chatbots), chat sessions, conversation results, and workspace settings.

The Unpublish Typebot operation specifically allows users to unpublish a previously published chatbot, effectively taking it offline or making it unavailable to end users.

Practical scenarios for this node include:

  • Automating chatbot lifecycle management within workflows.
  • Publishing or unpublishing chatbots based on business needs or deployment schedules.
  • Managing chat sessions and retrieving conversation analytics programmatically.
  • Importing/exporting chatbot configurations and results.

Example use case: Automatically unpublish a chatbot at the end of a campaign or maintenance window to prevent user access until updates are complete.

Properties

Name Meaning
Typebot ID The unique identifier of the typebot to operate on.
Additional Fields A collection of optional fields that can customize behavior or provide extra data. Options include:
- Stream Enabled: Enable real-time streaming responses.
- Prefilled Variables: Variables to prefill in the chatbot session.
- Result ID: Existing result ID to continue a conversation.
- Theme: Custom theme configuration as JSON.
- Settings: Custom settings as JSON.
- Icon: Emoji or URL icon for the typebot.
- Typebot JSON: Full typebot configuration as JSON (for import/update).
- Export Format: Format for exporting results (CSV, JSON, Excel).
- Filename: Custom filename for file uploads.
- File Size Limit MB: Maximum allowed file size for uploads in megabytes.

For the Unpublish Typebot operation, only the Typebot ID is required; additional fields are not used.

Output

The node outputs a JSON object representing the response from the Typebot API for the unpublish request. This typically includes confirmation of the unpublish action or relevant status information.

Output structure example (simplified):

{
  "json": {
    // API response confirming unpublish success or details
  }
}

No binary data output is involved in 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.
  • The node uses an external proxy service (https://n8ntools.io/api/v1/proxy/typebot) to forward requests to the Typebot API.
  • Workspace ID is required as part of the context for some operations but not directly for unpublishing.

Troubleshooting

  • Common issues:

    • Invalid or missing Typebot ID will cause the API call to fail.
    • Authentication errors if API key or token is incorrect or expired.
    • Network or proxy connectivity issues may prevent successful API calls.

  • Error messages:

    • "Unknown typebot operation: unpublishTypebot": Indicates a mismatch or typo in the operation name; ensure correct operation selection.
    • Authorization errors: Check that the API token and API key credentials are correctly set up.
    • HTTP errors from the API (e.g., 404 Not Found): Verify the Typebot ID exists and is accessible.

  • Resolution tips:

    • Double-check all required input parameters.
    • Confirm credentials and API endpoint configurations.
    • Use the node's "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion