Actions23
- Typebot Actions
- Chat Actions
- Result Actions
- Workspace Actions
Overview
This node provides a comprehensive integration with Typebot.io, a self-hosted chatbot builder that uses visual flows. It allows users to manage typebots (chatbots), chat sessions, conversation results, and workspace settings directly within n8n workflows.
Common scenarios where this node is beneficial include:
- Automating chatbot management tasks such as creating, updating, publishing, or deleting typebots.
- Starting new chat sessions or continuing existing conversations programmatically.
- Retrieving and exporting conversation results for analysis.
- Managing workspace members and invitations.
Practical examples:
- Automatically start a chat session when a user submits a form and process the chatbot's response.
- Export all conversation results in CSV format for reporting purposes.
- Update a typebot’s configuration dynamically based on external triggers.
- Invite new members to a workspace when onboarding new team members.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | A collection of optional fields to customize the operation: - Stream Enabled: Enable streaming for real-time responses. - Prefilled Variables: Variables to prefill in the typebot (name-value pairs). - Result ID: Existing result ID to continue conversation. - Theme: Custom theme configuration as JSON. - Settings: Custom settings as JSON. - Icon: Typebot icon (emoji or URL). - Typebot JSON: Typebot configuration as JSON for import or update. - Export Format: Format for exporting results; options are CSV, JSON, Excel. - Filename: Custom filename for file uploads. - File Size Limit MB: File size limit in megabytes. |
Note: The node also requires selecting a Resource and Operation, but since you requested only the Default resource and operation properties, the above covers the additionalFields input which is the main customizable property here.
Output
The node outputs an array of items where each item contains a json field holding the API response data from Typebot.io. The structure of the JSON depends on the specific API endpoint called, but generally includes details about typebots, chat sessions, results, or workspace information.
If the operation involves exporting results, the output will contain the exported data in the selected format (CSV, JSON, or Excel).
Binary data output is not explicitly handled by this node; it focuses on JSON responses from the Typebot API.
Dependencies
- Requires an API key credential for authenticating with the Typebot.io API.
- Needs configuration of the API base URL, API token, and workspace ID via credentials.
- Uses an external proxy service (
https://n8ntools.io/api/v1/proxy/typebot) to forward requests to the Typebot API. - Requires internet access to communicate with both the proxy and Typebot API endpoints.
Troubleshooting
- Unknown Resource or Operation Errors: If you select a resource or operation not supported by the node, it throws an error indicating the unknown resource or operation. Ensure you select valid combinations.
- Authentication Failures: Missing or invalid API keys or tokens will cause authentication errors. Verify your credentials are correctly configured.
- JSON Parsing Errors: Some inputs accept JSON strings (e.g., theme, settings, typebotJson). Invalid JSON syntax will cause parsing errors. Validate JSON before input.
- API Rate Limits or Network Issues: Since the node relies on external APIs, network failures or rate limits may cause request failures. Implement retry logic or handle errors gracefully.
- File Upload Size Limits: When generating upload URLs, ensure the file size does not exceed the specified limit to avoid rejection.