N8N Tools - Typebot API icon

N8N Tools - Typebot API

Complete Typebot.io integration - Self-hosted chatbot builder with visual flows

Actions23

Overview

The Publish Typebot operation in this node allows users to publish a specific Typebot (a chatbot created with Typebot.io) to make it live and accessible. This is useful when you have finished building or updating your chatbot and want to deploy it for end-users to interact with.

Typical scenarios include:

  • Deploying a newly created chatbot after configuration.
  • Republishing an updated chatbot after making changes.
  • Automating the deployment process as part of a CI/CD pipeline for chatbots.

For example, after designing a customer support chatbot in Typebot.io, you can use this node operation to publish it automatically once all configurations are finalized, enabling customers to start interacting with it immediately.

Properties

Name Meaning
Typebot ID The unique identifier of the Typebot to be published.
Additional Fields Optional extra settings including:
- Stream Enabled Enable streaming for real-time responses (boolean).
- Prefilled Variables Variables to prefill in the Typebot session (name-value pairs).
- Result ID Existing result ID to continue a conversation (string).
- Theme Custom theme configuration provided as JSON.
- Settings Custom settings for the Typebot provided as JSON.
- Icon Icon for the Typebot, either an emoji or URL string.
- Typebot JSON Full Typebot configuration as JSON (used for import/update operations).
- Export Format Format for exporting results (CSV, JSON, Excel) - not relevant for publishing but available.
- Filename Custom filename for file uploads (not relevant here).
- File Size Limit MB File size limit in megabytes for uploads (not relevant here).

Note: For the Publish Typebot operation specifically, only the Typebot ID is strictly required; other additional fields may be ignored or unused.

Output

The output is a JSON object representing the response from the Typebot API after attempting to publish the specified Typebot. It typically contains details about the published Typebot status or any error messages if the operation failed.

Example structure (simplified):

{
  "id": "typebot-id",
  "name": "My Chatbot",
  "published": true,
  "publishedAt": "2024-01-01T12:00:00Z",
  "url": "https://typebot.io/your-published-bot-url"
}

This output confirms that the Typebot has been successfully published and provides metadata such as the publication timestamp and public URL.

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.
  • The node sends requests through a proxy service hosted at https://n8ntools.io/api/v1/proxy/typebot which requires an additional API key for access.
  • Workspace ID is used internally to scope some operations but is managed via credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing Typebot ID will cause the API to reject the request.
    • Authentication errors if API keys or tokens are incorrect or expired.
    • Network connectivity problems to the proxy or Typebot API endpoints.
    • JSON parsing errors if custom JSON fields (like theme or settings) are malformed.

  • Error messages:

    • "Unknown typebot operation: publishTypebot": Indicates a mismatch in operation name; ensure correct operation selected.
    • "Unauthorized" or "Forbidden": Check API credentials and permissions.
    • "Typebot not found": Verify the Typebot ID exists and belongs to the workspace.

  • Resolutions:

    • Double-check all input parameters, especially the Typebot ID.
    • Validate JSON inputs using external tools before passing them.
    • Confirm API credentials are correctly set up and active.
    • Test network connectivity and proxy availability.

Links and References

Discussion