N8N Tools - Typebot API
Actions23
- Typebot Actions
- Chat Actions
- Result Actions
- Workspace Actions
Overview
The "Start Chat" operation of the Chat resource in this node initiates a new chat session with a published Typebot chatbot. It sends a user message to the chatbot and optionally configures the chat session with streaming, prefilled variables, themes, settings, and continuation from an existing conversation result.
This node is useful for automating interactions with Typebot chatbots, enabling workflows that require conversational AI responses. For example, it can be used to start customer support chats, gather user input interactively, or integrate chatbot conversations into larger automation pipelines.
Practical examples:
- Starting a chat session with a public chatbot by sending an initial greeting message.
- Prefilling variables such as user name or preferences before starting the chat.
- Enabling streaming mode to receive real-time partial responses from the chatbot.
- Continuing a conversation from a previous chat result ID.
Properties
| Name | Meaning |
|---|---|
| Public ID | The public identifier of the published Typebot chatbot to start the chat with. |
| Message | The message text to send to the Typebot to initiate the chat session. |
| Additional Fields | Optional extra configuration fields: |
| - Stream Enabled | Enable streaming mode for real-time response updates (boolean). |
| - Prefilled Variables | Variables to prefill in the chatbot before starting the chat. Each variable has a name and value. |
| - Result ID | An existing conversation result ID to continue the chat from a previous session. |
| - Theme | Custom theme configuration provided as JSON to style the chatbot interface. |
| - Settings | Custom settings for the chatbot session provided as JSON. |
| - Icon | Icon for the Typebot, either an emoji or URL string. |
Output
The node outputs a JSON object representing the response from the Typebot API after starting the chat session. This typically includes details about the chat session, such as session ID, messages exchanged, and any metadata returned by the chatbot service.
If streaming is enabled, the output may include streamed partial responses in real time.
No binary data output is produced by this operation.
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 node makes HTTP POST requests to the Typebot API endpoints to start chat sessions.
- No additional external dependencies beyond the Typebot API and n8n's HTTP request helper.
Troubleshooting
Common issues:
- Invalid or missing Public ID will cause the API call to fail.
- Incorrect or expired API token or API key credential will result in authentication errors.
- Malformed JSON in the Theme or Settings fields can cause parsing errors.
- Using a Result ID that does not exist or belongs to another chatbot may cause continuation failures.
Error messages:
"Unknown chat operation: startChat"— indicates a misconfiguration of the operation parameter.- API authentication errors usually mention invalid token or unauthorized access; verify credentials.
- JSON parse errors for Theme or Settings indicate invalid JSON syntax; validate JSON before input.
Resolutions:
- Double-check all required IDs and tokens are correctly set.
- Validate JSON inputs using online tools before entering them.
- Ensure the Typebot is published and accessible via the given Public ID.
- Use the node's "Continue On Fail" option to handle errors gracefully in workflows.