Documentation

Everything you need to set up and extend

Guides, references, and copy-paste examples for the chatbot, the contact form, the blog widget, and the API.

Getting Started

Create your account, build your first chatbot, and go live in minutes.

Widget Embed

Install the chat widget, contact form, and blog widget on any site.

Dashboard Guide

Leads, analytics, live chat, meetings, and settings walkthrough.

API Reference

REST endpoints, webhooks, and authentication for custom integrations.

Getting started

This guide takes you from sign-up to a live AI chatbot on your website in under five minutes.

Quick start checklist

  1. Sign up at /auth/register — one month free, no card
  2. Create your first chatbot in the dashboard
  3. Customise appearance, greeting, and persona
  4. Copy the embed code from Embed & Preview
  5. Paste the snippet before </body>

Widget embed

The Botawk widget loads asynchronously and supports three modes:

  • Chatbot — AI conversations with lead capture
  • Contact Form — structured enquiry collection
  • Blog Widget — latest posts grid or list on any page

Embed snippet

<script src="http://localhost:3000/widget.js" data-chatbot-id="YOUR_ID"></script>

Widget not appearing?

  • Confirm the snippet sits before </body> or inside <head>
  • Wait a few minutes after first install while the bot trains on your site
  • Check the chatbot status is active in Embed & Preview

Dashboard guide

The sidebar is the fastest way to find anything:

Home

At-a-glance totals for chats, leads, and usage this billing period.

Business Profile

Your company name and website. Used to verify embed origins and analytics.

Live Chat

Watch conversations in flight and take over as a human agent.

Leads

Every captured lead from chat and form, with CSV export.

Meetings

Bookings made in chat, manual or Calendly-sourced.

Embed

Install code, widget customisation, and the blog widget configuration.

Analytics

Traffic, conversation intelligence, and attribution. From Pro up.

Reports

Scheduled PDF and CSV reports. Ultimate only.

Billing

Plan, payment method, invoices, and usage limits.

Settings

Chatbot persona, integrations, GDPR tools, and team.

API reference

Every endpoint is JSON over HTTPS and requires an authenticated session or bearer token.

Method Endpoint Purpose
POST /api/leads/contact-form Submit a contact form lead
POST /api/chat/message Send a visitor chat message
GET /api/analytics/track Record a pageview event
GET /api/widget/config Fetch public widget config

Webhooks

Point Botawk at any HTTPS endpoint and we will POST every new lead to it. Failed deliveries retry with backoff and land in a dead-letter queue you can inspect in the dashboard.

  • Full lead payload including source page and referrer
  • Automatic retry on 5xx and timeouts
  • Delivery log per event, visible in the dashboard

Webhooks are available on Enterprise and Ultimate.

Read enough?

Try it on your own site. It takes two minutes and nothing is charged.

Get Started Free Help Center