Developer Documentation

Self-Hosting

Typebot is fully open source (available on GitHub) and can be self-hosted using Docker. Clone the repository, configure environment variables (database, SMTP, storage), and run with docker-compose up.

HTTP / Webhook Integration

Bots can be triggered and controlled via HTTP requests, allowing integration with any backend, language, or automation platform:

POST https://typebot.io/api/v1/typebots/{typebotId}/startChat
Content-Type: application/json
{ "prefilledVariables": { "email": "user@example.com" } }

Custom Code Blocks

Each bot supports custom JavaScript and CSS blocks for advanced logic, DOM manipulation, or API calls that aren't covered by native integrations.

Key API Capabilities

Start/continue chat sessions via REST API
Prefill variables from URL parameters or API payloads (hidden fields)
Webhook blocks to POST collected data to any endpoint in real time
Multiple AI providers configurable per block (OpenAI, and others)

Embedding SDK

Add a bot to any webpage with a lightweight JS snippet:

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

Supports initBubble, initPopup, and initStandard embed modes.