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 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 rules or schedules.
  • Managing chat sessions programmatically.
  • Exporting conversation analytics for reporting.

For example, you might use this node to automatically unpublish a chatbot at the end of a campaign or when maintenance is required.

Properties

Name Meaning
Typebot ID The unique identifier of the typebot to operate on.
Additional Fields A collection of optional fields that can be used across different operations (not relevant for unpublish).

Since the operation is Unpublish Typebot, only the Typebot ID property is required and relevant here.

Output

The output of the node is a JSON object representing the response from the Typebot API after attempting to unpublish the specified typebot. This typically includes status information about the unpublish action.

Example output structure:

{
  "json": {
    // API response data confirming unpublish success or failure
  },
  "pairedItem": {
    "item": 0
  }
}

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Typebot API.
  • Needs configuration of the API URL, API token, and workspace ID in the node credentials.
  • The node sends requests through a proxy service hosted at https://n8ntools.io/api/v1/proxy/typebot using an additional API key for that proxy.

Troubleshooting

  • Common issues:

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

  • Error messages:

    • "Unknown typebot operation: unpublishTypebot": Indicates a misconfiguration or unsupported operation; ensure the operation name is correct.
    • API authorization errors: Check that the API token and keys are valid and have sufficient permissions.
    • HTTP errors like 404 or 400: Verify the Typebot ID exists and is correct.

  • Resolution tips:

    • Double-check all input parameters, especially the Typebot ID.
    • Confirm credentials and API tokens are correctly set up.
    • Enable "Continue On Fail" in the node to handle errors gracefully in workflows.

Links and References

Discussion