YakWP Documentation

What is YakWP?

YakWP is a self-hosted AI chatbot plugin for WordPress. It lets you add a smart, conversational widget to your website that can answer visitor questions, capture leads, and even help you make sales — all while running on your own site with your own API key.

Why YakWP?

• Bring Your Own Key (BYOK) — Use Google Gemini free tier, OpenAI, or OpenRouter.
• Knows your content — Answers based on your actual WordPress posts and pages.
• Speaks your visitor’s language — Auto-detects language in real time.
• Works out of the box — Install, paste your API key, and go.
• One-time Pro license — No subscriptions. Pay once, own it forever.

Before You Begin

You will need:

1. A WordPress website (self-hosted or managed).
2. Admin access to your WordPress dashboard.
3. An API key from one of these providers:
   • Google Gemini (free tier available)
   • OpenAI
   • OpenRouter

Tip: If you are just testing, start with Google Gemini. They offer a generous free tier that is perfect for getting started.

Installation

Method 1: Upload the ZIP file

1. Go to yakwp.com/downloads and download the latest .zip file.
2. Log in to your WordPress Admin dashboard.
3. In the left sidebar, click Plugins → Add New.
4. At the top of the page, click the Upload Plugin button.
5. Click Choose File, select the yakwp.zip you downloaded, then click Install Now.
6. After installation finishes, click Activate Plugin.

Method 2: Manual upload (via FTP / file manager)

1. Download the ZIP from yakwp.com/downloads.
2. Unzip the file on your computer. You should see a folder named yakwp.
3. Upload that folder to your WordPress installation at:
   /wp-content/plugins/
4. Return to your WordPress Admin, go to Plugins → Installed Plugins, find YakWP, and click Activate.

After activation, you will see a new YakWP menu item in your WordPress admin sidebar.

First-Time Setup

Step 1 — Open YakWP Settings

In your WordPress admin sidebar, click YakWP → Settings.

Step 2 — Choose Your AI Provider

Under AI Provider, select one of:

• Google Gemini
• OpenAI
• OpenRouter

Paste your API Key into the key field.

Where do I get an API key?

• Google Gemini: Visit ai.google.dev and click “Get API key in Google AI Studio.”
• OpenAI: Visit platform.openai.com and go to API keys.
• OpenRouter: Visit openrouter.ai and go to Keys.

Step 3 — Pick a Chatbot Mode

Choose how your chatbot should behave:

• Sales — Helps visitors find products, answers pricing questions, and guides them toward a purchase.
• Support — Troubleshoots issues, answers FAQs, and routes complex tickets to your team.
• Explain — Breaks down complex topics in simple terms (great for blogs, courses, or documentation).
• Custom — Write your own system prompt for full control.

Step 4 — Customize the Widget

• Welcome Message — The first thing visitors see when they open the chat.
• Widget Color — Pick a color that matches your brand.
• Position — Choose whether the widget appears in the bottom-left or bottom-right corner.
• Quick Reply Buttons — Add preset buttons like “Pricing” or “Contact Sales” so visitors can tap instead of type.

Step 5 — Save and Test

Click Save Changes at the bottom of the page. Then visit your website in a new tab and look for the chat bubble. Open it and try sending a message!

Settings Reference

Setting	What It Does
AI Provider	Choose Gemini, OpenAI, or OpenRouter.
API Key	Your secret key from the chosen provider.
Chatbot Mode	Sales / Support / Explain / Custom.
Custom Prompt	Write your own instructions for the AI (Custom mode only).
Welcome Message	Greeting shown when chat opens.
Widget Color	Accent color of the chat widget.
Widget Position	Bottom-left or bottom-right.
Quick Reply Buttons	Pre-defined one-tap buttons for visitors.
Lead Capture	Turn on/off the form that collects visitor emails.
Lead Capture Message	Text shown above the email input.
Notification Email	Where lead alerts are sent.
Webhook URL	URL to receive conversation data (for n8n, Zapier, Make). YakWP sends the full conversation payload.
Dark Mode	Enable a dark-themed chat widget.
Spam Protection	Add a simple challenge to reduce bot submissions.
GDPR Notice	Show a privacy notice before chat starts.
License Key (Pro)	Enter your Lemon Squeezy license to unlock Pro.

Chatbot Modes

YakWP comes with four built-in personalities. You can switch anytime in Settings.

Sales Mode

• Actively suggests products and services.
• Answers pricing questions using your site content.
• Uses persuasive but friendly language.
• Perfect for: e-commerce, agencies, SaaS, consultants.

Support Mode

• Focuses on solving problems.
• Looks through your help articles, docs, and blog posts.
• Offers step-by-step guidance.
• Perfect for: software companies, service businesses, membership sites.

Explain Mode

• Breaks down complicated topics into plain language.
• Great for educational sites, blogs, and nonprofits.
• Asks clarifying questions if the visitor is vague.
• Perfect for: online courses, tutorials, knowledge bases.

Custom Mode

• You write the system prompt.
• Full creative control.
• Use this if you need a very specific tone, rules, or behavior.

Example Custom Prompt:
“You are a friendly travel assistant for a boutique hotel in Paris. Help guests with check-in times, local attractions, and room upgrades. Always mention our complimentary breakfast.”

RAG — Answers From Your Content

RAG stands for Retrieval-Augmented Generation. YakWP reads your WordPress content and uses it to answer questions accurately.

How it works

1. YakWP indexes your published posts, pages, and other content.
2. When a visitor asks a question, YakWP searches that index.
3. It passes the most relevant text to the AI.
4. The AI answers using your actual words, not made-up facts.

Why this matters

• No hallucinations — The AI won’t invent prices, policies, or product details.
• Always up to date — If you edit a post, the chatbot’s knowledge updates too.
• No training required — Just write content on your site like you already do.

Lead Capture

Turn visitors into leads automatically.

How to enable

1. Go to YakWP → Settings.
2. Find the Lead Capture toggle and turn it On.
3. Enter a Lead Capture Message.
4. Enter your Notification Email.
5. Save changes.

Analytics Dashboard

YakWP tracks every conversation so you can learn what visitors care about.

In your WordPress admin sidebar, click YakWP → Analytics. You will see:

• Total Conversations — How many chats happened this week / month.
• Unique Visitors — How many different people used the chat.
• Popular Questions — The most common topics visitors ask about.
• Lead Conversion Rate — Percentage of chats that resulted in an email capture.
• Peak Hours — When your visitors are most active.

Webhooks (n8n, Zapier, Make)

Webhooks let you send YakWP conversation data to thousands of other apps automatically.

What you can do with webhooks

• Send new leads to your CRM (HubSpot, Pipedrive, Salesforce).
• Log conversations in a Google Sheet or Airtable.
• Trigger Slack or Discord notifications for urgent questions.
• Build advanced automations with n8n, Zapier, or Make.

How to set up

1. Go to YakWP → Settings.
2. Scroll to Webhook URL.
3. Paste the webhook URL from your automation tool.
4. YakWP sends conversation data to your webhook URL whenever a chat message is exchanged. The payload includes the visitor message, AI response, captured email, page URL, and timestamp.
5. Save changes.

Pro Features

YakWP Pro is a one-time purchase that unlocks advanced features.

• White-Label Branding — Remove the “Powered by Yak” credit from the widget.
• Custom Widget CSS — Add your own CSS to perfectly match your brand.
• Conversation Export (CSV) — Download all conversations for offline analysis or reporting.
• Priority Support — Jump to the front of the support queue.
• Lifetime Updates — Every future improvement, forever.

License tiers

Sites	Price
1 site	€64
3 sites	€129
10 sites	€299
30 sites	€499

How to activate your Pro license

1. In WordPress, go to YakWP → Settings.
2. Scroll to the License Key field.
3. Paste your license key.
4. Click Activate License.

Troubleshooting

The chat widget does not appear on my site

1. Make sure YakWP is activated in Plugins → Installed Plugins.
2. Check that you have saved your settings at least once in YakWP → Settings.
3. Clear any WordPress cache plugin.
4. Clear your browser cache and refresh the page.
5. Check if your theme has aggressive JavaScript minification that might block the widget.

The AI does not reply / I see an error

1. Verify your API Key is correct and has not expired.
2. Check your AI provider’s dashboard for usage limits or billing issues.
3. Look at your browser’s Console (F12 → Console tab) for JavaScript errors.
4. Check your WordPress error log.

The chatbot gives wrong answers about my content

1. Make sure the page or post is published (not a draft).
2. Rebuild the content index if a manual sync button is available.
3. Check if the content is behind a login or membership wall — YakWP can only read public content.
4. For very new content, wait a few minutes after publishing before testing.

Lead capture emails are not arriving

1. Confirm the Notification Email address is correct.
2. Check your spam / junk folder.
3. If your server uses SMTP (recommended), verify your SMTP plugin is working.
4. Try a different email address to rule out inbox filters.

License activation failed

1. Copy the key directly from your Lemon Squeezy email — do not retype it.
2. Remove any leading or trailing spaces.
3. Ensure your site can reach the Lemon Squeezy validation servers (not blocked by a firewall).

FAQ

Q: Is YakWP free?
A: Yes. The core plugin is free and includes the AI chatbot, RAG, lead capture, analytics, webhooks, dark mode, and spam protection. Pro is a one-time upgrade for advanced features.

Q: Do I need a credit card to try it?
A: No. The plugin is free. If you choose Google Gemini, you can use their free tier with no credit card required.

Q: Will it slow down my website?
A: No. YakWP loads asynchronously and only initializes when a visitor interacts with the widget. It does not block your page from loading.

Q: Can I use it on a client site?
A: Yes. Pro licenses cover 1, 3, 10, or 30 sites.

Q: What languages does it support?
A: YakWP auto-detects the visitor’s language and replies in the same language. It supports virtually every language that your AI provider supports.

Q: Is my data private?
A: Yes. YakWP is self-hosted. Conversations live on your server. Only the message text is sent to your chosen AI provider to generate a reply.

Q: Can I cancel or get a refund?
A: Pro is a one-time purchase. Refunds are handled per Lemon Squeezy’s standard policy. Contact support if you are unhappy for any reason.

Q: Where do I get help?
A: Free users can use community forums. Pro users get priority support via email. Visit yakwp.com/contact.

---

Website: yakwp.com | Pricing: yakwp.com/pricing | Download: yakwp.com/downloads