Documentation
Everything you need to go live.
42 pages covering setup, training, live chat, lead qualification, integrations and the REST API. Start at the beginning, or jump to what you need.
The four things you will do
Install the widget
One script tag, before the closing body tag, on any platform.
Train it on your content
Crawl your website or upload PDFs, DOCX, TXT and Markdown.
Qualify the leads
BANT, MEDDIC, CHAMP or GPCTBA scoring from the conversation itself.
Push events out
Signed webhooks into your CRM, or read everything over REST.
All documentation
Ten sections, in reading order. Every page links to the next.
Getting started
What OyeChats is, how the pieces fit together, and the fastest path to a live chatbot.
- IntroductionOyeChats turns the content you already have. Your website, help centre and documents. Into an AI chatbot that answers visitor questions on your site, captures leads, and hands off to a human when it matters.
- QuickstartSign up, train a chatbot on your site, test it, and install it. Five steps, roughly five minutes of your attention plus crawl time.
- Core conceptsThe eight nouns that everything else in OyeChats is built from. Worth five minutes before you configure anything.
- Dashboard tourWhere each thing lives in the OyeChats dashboard, so the rest of these docs can point at a place rather than describe it.
Building a chatbot
Create it, train it on your content, shape how it answers, and test it before it goes live.
- Create a chatbotWhat a chatbot is made of, how many you can have, and what OyeChats fills in for you when you create one.
- Training & knowledgeTwo ways to teach a chatbot: crawl a website, or upload files. This page covers both, what is supported, what it costs, and how to keep the knowledge base fresh.
- Controlling answersPersonality, tone, what the chatbot is allowed to discuss, and how it links out. These settings shape every reply without touching the knowledge base.
- TestingHow to test a chatbot without burning credits or shipping a bad first impression, and what to check before you install it.
The website widget
Install it, style it, control its behaviour, and lock it to your own domains.
- InstallOne script tag, any website. This page covers the snippet, where it goes, how loading works, and how to verify the install.
- Platform guidesWhere the script tag goes on the platforms customers ask about most. In every case it is the same snippet.
- Appearance & copyColours, avatar, launcher, every visitor-facing string, and branding removal. All of it is dashboard configuration, no code.
- Behaviour & timingWhen the widget speaks first, how long it waits, when it offers a human, and the JavaScript API for driving it from your own code.
- Widget securityYour bot key is public. This page explains why that is fine, and how to stop anyone from embedding your chatbot on a site you do not own.
Conversations & live chat
How a conversation moves from AI to a human, who it goes to, and what happens when nobody is available.
- Conversation lifecycleEvery conversation is in exactly one of four states. Knowing which is which explains most of what you see in the Support inbox.
- Live chatTurning on human handoff, what visitors see at each stage, and the seven availability states that decide what happens when they ask.
- Operators & seatsWho can take a live chat, how they sign in, how many can work at once, and how seats are billed.
- Canned responsesSaved snippets your operators insert with a slash shortcut instead of retyping the same answer.
- Offline messagesWhat happens to a visitor who wants a human when no human is there, and how you follow up.
Leads & qualification
Capturing contact details, scoring intent, and getting qualified leads out to your team.
- Capturing leadsThree ways contact details reach your Leads list, how to configure the form, and what real-time email checking does.
- Qualification frameworksOyeChats reads the conversation and scores how ready the visitor is to buy, using the sales framework you choose.
- Tiers & thresholdsThe four tiers, the score bands behind them, and what fires when a lead crosses one.
- Visitor intelligenceWhat OyeChats can infer about a visitor beyond what they typed, and, just as importantly, what it cannot.
- Working with leadsFiltering, following up, and getting leads out of OyeChats and into your own systems.
Analytics & reporting
What the numbers mean, which ones to act on, and how visitor journeys are reconstructed.
- Analytics overviewVolume, quality and outcome metrics for every chatbot, plus the two reports that tell you what to fix next.
- Visitor journeyThe pages a visitor saw before, during and after chatting, which is where chat stops being a support channel and starts being attribution.
- Reports & exportsGetting numbers out of OyeChats and into a spreadsheet, a warehouse, or your own dashboard.
Integrations
Push events to your own systems, connect a CRM, book meetings in-chat, and route notifications.
- WebhooksOyeChats POSTs a signed JSON payload to your endpoint when something happens. This page covers setup, signature verification and retry behaviour.
- Webhook eventsThe five events OyeChats sends, and the exact contents of each one's `data` object.
- CRM & automationThere is no per-CRM connector. There is one webhook and an automation platform, which reaches every CRM including yours.
- Meeting bookingLet visitors book a call inside the chat instead of being sent away to a scheduling page they may never open.
- NotificationsWho gets told what, on which channel, when something happens in a conversation.
REST API
Authentication, conventions, errors, rate limits, and the endpoints you will actually use.
- AuthenticationOne base URL, three authentication personas, and a small set of conventions that hold across every endpoint.
- Errors & rate limitsWhat failures look like on the wire, which status codes mean what, and how to pace your requests.
- Endpoint referenceThe endpoints most integrations use, grouped by what they are for. The [OpenAPI specification](/docs/api/overview) is the exhaustive list.
Account & billing
Plans, credits, invoices, your team, and how your data is handled.
- Plans & limitsWhat a plan actually controls, how limits are enforced, and how to check what your workspace is entitled to right now.
- CreditsOne unit meters everything OyeChats does on your behalf. This page lists exactly what costs what.
- Billing & invoicesCurrency, tax, invoices, what happens when a payment fails, and how cancellation actually works.
- Team & accessInviting people, what each role can do, signing in, and account security.
- Data & privacyWhat OyeChats stores, who is the controller of what, how long things are visible, and how deletion works. The binding detail is in the legal documents this page links to.
Troubleshooting & help
The problems customers actually hit, what causes them, and where to get a human.
Stuck on something?
Check troubleshooting first, then talk to us.