Documentation
Yokaify documentation
Yokaify is a behavior-driven proactive conversion mascot — an animated mascot that watches for hesitation and steps in with grounded, on-brand answers. These docs cover installation, your knowledge base, configuration, and how to measure real lift.
Getting started
Installation
Installing the widget
Add the Yokaify script to any site — plain HTML, Shopify, WordPress, Webflow, or a single-page app.
Shopify
Add the Yokaify mascot to a Shopify storefront — via the theme editor in about two minutes, on any Shopify plan.
WooCommerce / WordPress
Add the Yokaify mascot to a WordPress or WooCommerce site with a footer-code plugin or a child-theme hook.
Webflow
Add the Yokaify mascot to a Webflow site using Project Settings → Custom Code.
Wix & Squarespace
Add the Yokaify mascot to Wix (Custom Code) or Squarespace (Code Injection) sites.
React, Next.js & SPAs
Add the Yokaify mascot to a single-page app — React, Next.js, Vue, Astro, or any framework. Route changes are detected automatically.
Custom HTML
Add the Yokaify mascot to any hand-built or server-rendered site with one script tag.
Verify installation
Confirm the Yokaify widget is installed correctly, and fix the most common install problems.
Core concepts
How Yokaify works
The lifecycle of a Yokaify session — from script load to a grounded, behavior-triggered intervention.
The behavior engine
How Yokaify decides when to step in — the signals it reads and the intent patterns it recognizes.
The mascot
Why a face beats an icon, and the animated characters Yokaify ships with.
Answers & grounding
How Yokaify answers questions using only your content — and why it won't make things up.
Dashboard
Dashboard tour
A map of the Yokaify dashboard — what lives where, and which page answers which question.
Inbox & conversations
Read every mascot conversation, spot frustrated visitors with sentiment scores, and follow a conversation to its outcome.
Assists
Review every proactive intervention the behavior engine fired — what triggered it, what the mascot did, and what it led to.
Mascot Studio
Choose a mascot from the marketplace, customize its look and personality, or commission a bespoke character for your brand.
Connections
Route Yokaify escalations and leads into the tools your team already uses — helpdesks, CRMs, Slack, or any endpoint via webhooks.
Alerts & notifications
Control which events email you, review the in-dashboard notification feed, and export your data.
Knowledge
Selling
Leads & escalation
Lead capture
When a visitor needs follow-up, the mascot collects their contact details in the flow of conversation — and delivers them to your dashboard, email, and webhooks.
Escalations & handoffs
When a visitor needs a human, the mascot hands off cleanly: an AI-written brief, a status workflow, and routing into your helpdesk.
Configuration
Measurement
Developers
Widget attributes
Developer reference for the embed script's data attributes — site key, API base, and the data-yk-* identity and context attributes.
Webhooks
Subscribe your endpoints to lead.created, escalation.created, assist.fired, and conversion.recorded events — with signed deliveries and a full delivery log.
Reference
FAQ & troubleshooting
Common questions about installing Yokaify, its behavior, privacy, and migrating from other tools.
Troubleshooting
Fixes for the most common issues: widget not appearing, wrong or missing answers, assists not firing, and webhook delivery failures.
Plans & limits
How Yokaify plans, monthly quotas, and booster packs work — and what happens when you hit a limit.