N8N Tools - Typebot API

Complete Typebot.io integration - Self-hosted chatbot builder with ChatGPT integration and visual flows.

Features

• Self-Hosted Freedom: Works with both Typebot Cloud and self-hosted instances
• ChatGPT Integration: Native OpenAI integration for intelligent conversations
• Visual Flow Builder: Drag-and-drop interface for complex chat workflows
• Multi-Channel: Deploy to websites, WhatsApp, and messaging platforms
• Webhook Automation: Real-time event handling and N8N workflow integration
• Complete CRUD: Full typebot management - create, update, publish, duplicate
• Result Analytics: Conversation results, analytics, and export capabilities
• State Management: Conversation variables and context management

Installation

npm install n8n-nodes-n8ntools-typebot-api

Credentials

Configure Typebot API credentials in N8N:

1. N8N Tools API Key: Your N8N Tools API key for billing and usage tracking
   • Get it from: N8N Tools Dashboard - API Keys
   • Required for all operations (enables credit-based billing)
2. API URL: Your Typebot instance URL
   • Cloud: https://app.typebot.io
   • Self-hosted: https://your-typebot-domain.com
3. API Token: Generate in Typebot Settings → My Account → API Tokens
4. Workspace ID: Found in your Typebot workspace settings

Credit System

This node operates on N8N Tools' credit-based billing system:

• API Calls: 1 credit per API request
• Chat Operations: 2 credits per conversation interaction
• Bulk Operations: Credits scale with data processed
• Real-time Tracking: Monitor usage in your N8N Tools dashboard

All requests are securely proxied through N8N Tools infrastructure for billing, monitoring, and enhanced reliability.

Operations

Typebot Management

• List Typebots: Get all typebots in workspace with folder filtering
• Get Typebot: Retrieve specific typebot configuration
• Create Typebot: Build new typebots programmatically
• Update Typebot: Modify existing typebot flows and settings
• Delete Typebot: Remove typebots permanently
• Publish/Unpublish: Control typebot availability
• Duplicate Typebot: Clone existing typebots with modifications
• Import Typebot: Create typebots from JSON configurations

Chat Operations

• Start Chat: Initialize conversations with users
• Start Preview Chat: Test typebots without saving data
• Continue Chat: Send messages to ongoing conversations
• Update Session: Modify typebot configuration during chat
• Generate Upload URL: Handle file uploads securely
• Save Client Logs: Debug chat sessions with detailed logging

Result Management

• List Results: Get conversation results with filtering
• Get Result: Retrieve specific conversation data
• Delete Result: Remove conversation records
• Export Results: Download results in CSV, JSON, or Excel formats

Workspace Operations

• Get Workspace: Retrieve workspace information
• Update Workspace: Modify workspace settings
• List Members: Get workspace collaborators
• Invite Member: Add team members to workspace

Usage Examples

Start Chat Session

{
  "resource": "chat",
  "operation": "startChat",
  "publicId": "typebot-public-id",
  "message": "Hello, I need help!",
  "additionalFields": {
    "isStreamEnabled": true,
    "prefilledVariables": {
      "variable": [
        {"name": "userName", "value": "John Doe"},
        {"name": "email", "value": "john@example.com"}
      ]
    }
  }
}

Continue Conversation

{
  "resource": "chat",
  "operation": "continueChat",
  "sessionId": "session-123-abc",
  "message": "I want to learn more about pricing"
}

Create New Typebot

{
  "resource": "typebot",
  "operation": "createTypebot",
  "typebotName": "Lead Generation Bot",
  "additionalFields": {
    "icon": "🤖",
    "folderId": "folder-123"
  }
}

Export Results

{
  "resource": "result",
  "operation": "exportResults",
  "typebotId": "typebot-456",
  "additionalFields": {
    "exportFormat": "csv"
  }
}

Advanced Features

Prefilled Variables

Pass dynamic data into typebot conversations:

• User information (name, email, phone)
• Session context (referrer, UTM parameters)
• Custom business data (product IDs, categories)

Streaming Responses

Enable real-time message streaming for better user experience with isStreamEnabled: true.

Custom Themes

Apply custom branding with theme configurations:

{
  "theme": {
    "general": {
      "background": {"type": "Color", "content": "#ffffff"}
    },
    "chat": {
      "hostBubbles": {"backgroundColor": "#0042DA", "color": "#ffffff"}
    }
  }
}

Self-Hosted Benefits

• Full Data Control: Keep all conversation data on your servers
• Custom Integrations: Direct API access without rate limits
• Cost Efficiency: No per-conversation charges
• Enterprise Security: On-premise deployment with custom security

Authentication

Uses Bearer token authentication with workspace-scoped access. Tokens provide secure API access while maintaining user permissions.

Rate Limiting

Typebot Cloud has generous rate limits. Self-hosted instances have no API restrictions, making them perfect for high-volume N8N automations.

Support

• Documentation: Typebot Docs
• Issues: GitHub Issues