TypebotInstall

Summary

Starts a Typebot chat session using its public ID. You can optionally send an opening message, reuse a result ID, enable streaming, register the session without starting the bot, prefill variables, and choose the text bubble format.

Inputs

• Public ID (required) — The Typebot's public ID.
• Additional Fields → Message — Optional message to send when starting the chat; included only when nonempty.
• Additional Fields → Result ID — Optional result ID to overwrite an existing result; included only when nonempty.
• Additional Fields → Is Stream Enabled — Whether to enable streaming for OpenAI blocks. Defaults to false.
• Additional Fields → Is Only Registering — Whether to register the session without starting the bot. Defaults to false.
• Additional Fields → Prefilled Variables — JSON object of variables to prefill; invalid JSON causes an error.
• Additional Fields → Text Bubble Content Format — Text bubble format: Rich Text (default) or Markdown.

Output shape

A list of items containing the JSON response from the Typebot chat start endpoint, with one item associated with each input item.

Requires Typebot API credentials. The request uses the configured chat base URL, falling back to the credential base URL. If Continue On Fail is enabled, a failed input item returns an object with an error message.

Examples

Example 1: Use an existing result

Set Result ID to the result to overwrite.

Example 2: Start with variables

Provide Prefilled Variables as a valid JSON object.

Links

• n8n community nodes installation guide