Developer Documentation

Self-Hosting

Typebot is fully open source (available on GitHub). You can self-host the entire platform using Docker. Clone the repo, configure your environment variables (database, SMTP, S3, etc.), and run with docker compose up.

HTTP / API Integration

Every published Typebot can be triggered and interacted with via HTTP requests, making it language-agnostic:

POST https://typebot.io/api/v1/typebots/{typebotId}/startChat
Content-Type: application/json
{
  "startParams": { "typebot": "my-typebot-id" }
}

Subsequent messages are sent to the /continueChat endpoint with the returned sessionId.

Embedding Options

Typebot provides an official JS library for web embedding:

<script type="module">
  import Typebot from 'https://cdn.jsdelivr.net/npm/@typebot.io/js@0.3/dist/web.js'
  Typebot.initBubble({ typebot: 'my-typebot-slug' })
</script>

Supported embed modes: initBubble, initPopup, initContainer.

Key Integration Points

OpenAI & multi-provider AI — connect GPT-4, Claude, and other models natively inside any flow block
Google Sheets — read/write rows in real time from conversation data
Webhooks — send collected data to any external endpoint
Custom JS/CSS — inject arbitrary code at the bot or block level
Hidden fields — pass URL parameters into the bot for user segmentation and personalization

Analytics API

Export drop-off rates, completion rates, and per-block metrics programmatically or via CSV export from the dashboard.