SBD Assistant

Documentation

v1.0.0

Welcome to SBD Assistant

AI-powered chatbot plugin for WordPress. Engage visitors, capture leads, and provide instant support.

OpenAI Powered Lead Capture Custom Knowledge Base

System Requirements

WordPress 6.0+

Latest version recommended

PHP 8.0+

With cURL extension enabled

MySQL 5.7+ / MariaDB 10.3+

For database storage

OpenAI API Key

Required for AI responses

Installation

1

Download the Plugin

Download the sbd-assistant.zip file from your account dashboard.

2

Upload to WordPress

Go to Plugins → Add New → Upload Plugin and select the zip file.

3

Activate the Plugin

Click Activate after installation completes.

4

Navigate to Settings

Find SBD Assistant in the WordPress admin sidebar to begin configuration.

License Activation

Important: A valid license is required for the chatbot to function. Without activation, the widget will not appear on your site.

  1. 1. Go to SBD Assistant → License tab
  2. 2. Enter your license key (received via email after purchase)
  3. 3. Click Activate License
  4. 4. You should see a green "Active" badge once verified

OpenAI Setup

Getting Your API Key

  1. 1. Go to platform.openai.com/api-keys
  2. 2. Sign in or create an OpenAI account
  3. 3. Click "Create new secret key"
  4. 4. Copy the key (starts with sk-)
  5. 5. Paste it in SBD Assistant → Settings → OpenAI API Key

Recommended Settings

Setting Recommended Description
Model gpt-4o-mini Best balance of speed and quality
Max Tokens 500 Controls response length
Temperature 0.7 Balance between creative and focused

Tip: Click "Test Connection" to verify your API key is working before saving.

Knowledge Base

The chatbot answers questions based on your custom knowledge base. Upload a JSON file with your business information.

JSON Structure

{
  "unique_id_01": {
    "name": "Your Company Name",
    "description": "What your company does",
    "contact": {
      "email": "support@example.com",
      "phone": "+1 234 567 8900"
    }
  },
  "sections": [
    {
      "title": "Products",
      "content": "Description of your products...",
      "keywords": ["product", "buy", "price"]
    },
    {
      "title": "Services",
      "content": "Description of your services...",
      "keywords": ["service", "help", "support"]
    }
  ],
  "faq": [
    {
      "question": "What are your business hours?",
      "answer": "We are open Monday-Friday, 9am-5pm."
    }
  ]
}

Tips for Better Responses

  • • Use relevant keywords for each section
  • • Include common questions in the FAQ section
  • • Keep content clear and concise
  • • Update regularly with new information

Appearance Settings

Primary Color

Choose a color that matches your brand. This applies to the chat button, header, and send button.

Widget Position

Place the chat widget in the bottom-right or bottom-left corner of your site.

Theme Mode

Choose between Light, Dark, or Auto (follows user's system preference).

Custom Logo

Upload a custom logo to display in the chat header instead of the default icon.

Lead Capture

Capture visitor information before or during the chat conversation.

Mode Behavior
Light Shows form after first message. User can dismiss and continue chatting.
Strict Requires information before chatting. User must fill form to continue.

Email Notifications: Enable "Send email notification" to receive an email whenever a new lead is captured.

Dashboard

The dashboard provides an overview of your chatbot's performance:

  • Total chats and messages
  • Leads captured
  • Activity chart (30-day overview)
  • Recent chat sessions
  • Knowledge base statistics

Chat History

View and manage all chat conversations:

  • Search chats by visitor name or email
  • Filter by status (Active/Ended)
  • View full conversation transcript
  • Delete old conversations

Leads Management

Manage captured leads effectively:

  • View lead details (name, email, phone)
  • Update status (New, Contacted, Converted, Archived)
  • Add notes to leads
  • Export leads to CSV

Common Issues

Widget not appearing

Solutions:

  • Verify license is activated
  • Check OpenAI API key is valid
  • Ensure knowledge base is uploaded
  • Clear website cache

Chatbot gives fallback responses

Solutions:

  • Add more relevant keywords to knowledge base
  • Include common questions in FAQ section
  • Check OpenAI API key has sufficient credits

CSS conflicts with theme (e.g., Elementor)

Solution: The plugin uses prefixed CSS classes. If you notice styling issues (pink outlines, wrong colors), check your theme's reset.css. Contact support with details.

OpenAI API errors

Solutions:

  • Verify API key is correct
  • Check OpenAI account has billing enabled
  • Ensure you haven't exceeded rate limits
  • Try a different model (gpt-4o-mini is recommended)

Knowledge base upload fails

Solutions:

Frequently Asked Questions

Can I use my own OpenAI account?
Yes! You provide your own OpenAI API key. This gives you full control over costs and usage limits.
How much does OpenAI API cost?
GPT-4o-mini costs approximately $0.15 per 1M input tokens and $0.60 per 1M output tokens. Average chat session costs less than $0.01.
Can I customize the chatbot's personality?
Yes! Set a custom bot name, welcome message, and fallback message in Settings. The chatbot's responses are based on your knowledge base content.
Is my data secure?
Yes. All data is stored in your own WordPress database. API keys are encrypted. Chat conversations are only sent to OpenAI for processing responses.
Can I use this on multiple sites?
Each license is valid for one domain. Contact us for multi-site licenses or agency plans.

Need Help?

Our support team is here to help you get the most out of SBD Assistant.