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

The "Import Typebot" operation in this node allows users to import a Typebot chatbot configuration into their workspace on the Typebot.io platform. This is useful for automating the deployment or updating of chatbots by importing their JSON configurations programmatically.

Typical scenarios include:

  • Migrating or restoring a chatbot from a saved JSON configuration.
  • Automating chatbot setup as part of CI/CD pipelines.
  • Bulk importing multiple chatbot configurations into a workspace.

For example, you might have a Typebot JSON export from another environment and want to import it into your current workspace with a new name using this node.

Properties

Name Meaning
Additional Fields Collection of optional fields to customize the import:
- Stream Enabled Enable streaming for real-time responses (boolean)
- Prefilled Variables Variables to prefill in the typebot; each variable has a name and value
- Result ID Existing result ID to continue conversation
- Theme Custom theme configuration as JSON
- Settings Custom settings as JSON
- Icon Typebot icon, either an emoji or URL
- Typebot JSON The full Typebot configuration as JSON to import/update (required for import operation)
- Export Format Format for exporting results (CSV, JSON, Excel) — not relevant for import but part of collection
- Filename Custom filename for file uploads
- File Size Limit MB File size limit in megabytes

Additional required properties for this operation:

Name Meaning
typebotName Name to assign to the imported Typebot

Output

The node outputs the response from the Typebot API after attempting to import the Typebot JSON configuration. The output JSON typically contains details about the newly created or updated Typebot, such as its ID, name, status, and other metadata returned by the API.

If the import fails, the output will contain an error message describing the failure.

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.
  • Workspace ID must be set in credentials to associate the imported Typebot with the correct workspace.

Troubleshooting

  • Common issues:

    • Invalid or malformed Typebot JSON configuration will cause the import to fail.
    • Missing required fields like typebotName or workspace ID can cause errors.
    • Authentication failures if API key or token are incorrect or expired.

  • Error messages:

    • "Unknown typebot operation: importTypebot" indicates a misconfiguration of the operation parameter.
    • API errors related to JSON parsing or validation will be returned from the Typebot API and surfaced in the node output.

  • Resolutions:

    • Validate the JSON configuration before import.
    • Ensure all required parameters and credentials are correctly set.
    • Check API keys and tokens for validity and permissions.

Links and References

Discussion