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, enabling users to manage chat sessions and conversations with self-hosted chatbots built using Typebot. Specifically, the "Continue Chat" operation allows sending a message to an existing chat session identified by a session ID, continuing the conversation flow.

Common scenarios include:

  • Continuing an ongoing chatbot conversation where context is preserved via the session ID.
  • Building conversational workflows that require back-and-forth interaction with a chatbot.
  • Integrating chatbot responses into automated processes or customer support systems.

For example, after starting a chat session with a user, you can use this node to send follow-up messages and receive responses without losing the session context.

Properties

Name Meaning
Session ID The unique identifier of the existing chat session to continue.
Message The message text to send to the chatbot within the ongoing session.
Additional Fields Optional extra parameters including:
- Stream Enabled Enable streaming for real-time response updates (boolean).
- Prefilled Variables Key-value pairs to prefill variables in the chatbot session.
- Result ID Existing result ID to continue the conversation from a specific result.
- Theme JSON object defining custom theme configuration for the chatbot UI.
- Settings JSON object for custom settings to modify chatbot behavior.
- Icon Emoji or URL string to set a custom icon for the chatbot.
- Typebot JSON JSON configuration of the typebot for import or update purposes.
- Export Format Format for exporting results (CSV, JSON, Excel) — not directly relevant for Continue Chat.
- Filename Custom filename for file uploads — not directly relevant here.
- File Size Limit MB Maximum allowed file size in megabytes for uploads — not directly relevant here.

Output

The node outputs a JSON object representing the response from the Typebot API for the continued chat message. This typically includes:

  • The chatbot's reply message(s).
  • Updated session information such as session state or IDs.
  • Any metadata related to the chat continuation.

If streaming is enabled, partial responses may be received in real-time.

The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the Typebot API.
  • Needs the Typebot API base URL and an API token configured in the node credentials.
  • The workspace ID is used internally to scope requests.
  • No additional external dependencies beyond the Typebot API service.

Troubleshooting

  • Invalid Session ID: If the session ID is incorrect or expired, the API will return an error. Verify the session ID from previous interactions.
  • Authentication Errors: Ensure the API key and token are valid and have sufficient permissions.
  • Malformed JSON in Additional Fields: When providing JSON for theme, settings, or typebotJson, ensure it is correctly formatted to avoid parsing errors.
  • Streaming Issues: If streaming is enabled but no partial responses are received, check network connectivity and API support for streaming.
  • API Endpoint Errors: Unknown operation or resource errors indicate misconfiguration of the operation or resource parameters.

Links and References

Discussion