Everything you need to go live.

From a one-line embed to full webhook setups. Get OyeChats running in minutes, not days.

Getting started

Quick start

Four steps from signup to a working chat widget. The whole flow takes about five minutes.

Step 1

Install the widget

Add a single script tag to your site and the chat widget appears instantly.

Step 2

Get your bot key

Find your unique bot key in the dashboard under Settings, Widget.

Step 3

Upload your docs

Upload PDFs, paste URLs, or connect a sitemap. OyeChats reads and indexes the rest.

Step 4

Configure webhooks

Push lead events, BANT scores, and chat transcripts to your own backend.

Widget setup

Add the chat widget

Paste the script tag before the closing </body> tag on any HTML page.

HTMLPaste before </body>

<!-- OyeChats Widget -->
<script
  src="https://cdn.oyechats.com/oyechats-widget.js"
  data-bot-key="YOUR_BOT_KEY"
  defer
></script>

Configuration attributes

The script tag only needs data-bot-key. Everything else, launcher position, colors, auto-open, and branding removal (Standard and above), is configured per bot in your dashboard.

Attribute	Type	Required	Description
`data-bot-key`	string	Required	Your unique bot key from the dashboard (Settings, Widget).

Webhooks

Receive real-time events

Configure a webhook URL in your dashboard and OyeChats will POST a signed JSON payload to your endpoint whenever these events occur.

tier_transition

Fires when a visitor crosses a qualification tier, e.g. becomes a hot lead.

lead_captured

Fires when a visitor submits name and email via the lead form.

handoff_requested

Fires when the visitor asks to speak with a human operator.

meeting_booked

Fires when a visitor books a meeting via Calendly or Zcal.

chat_closed

Fires when a chat session is closed.

Example payload for `tier_transition`

JSON

{
  "event": "tier_transition",
  "bot_id": 42,
  "timestamp": "2026-04-11T14:23:05Z",
  "data": {
    "session_id": "conv_8f3a2b1c",
    "lead": {
      "name": "Sarah Chen",
      "email": "sarah@acme.com"
    },
    "bant": {
      "budget": 82,
      "authority": 91,
      "need": 74,
      "timeline": 68,
      "composite": 79,
      "tier": "hot"
    }
  }
}

Signature verification. Every webhook request includes an X-OyeChats-Signature header (HMAC-SHA256). Verify it in your handler before processing.

REST API

Endpoints

Base URL: https://api.oyechats.com

Authenticate with your API key in the X-API-Key: <key> header.

Method	Endpoint	Description
GET	`/bots`	List all bots for your account.
GET	`/leads`	List captured leads with BANT scores.
GET	`/leads/export`	Export captured leads as CSV.
POST	`/ingest`	Upload a document (PDF, DOCX, TXT) to the knowledge base.
DELETE	`/documents/{name}`	Remove a document and its embeddings.
GET	`/analytics/dashboard`	Get conversation and lead metrics for a date range.

Full OpenAPI spec. Need the full spec? Download openapi.json and drop it into Postman, Insomnia, or any OpenAPI-compatible tool.

Need help integrating?

Our team typically responds within one business day.

Contact support →Email us