AI
BeastThemes AI Agent for WooCommerce Documentation
Pro + Agency Addon
BEASTTHEMES DOCUMENTATION

BeastThemes AI Agent for WooCommerce
Pro + Agency

Complete documentation for installation, AI, RAG, WooCommerce, bookings, channels, automation, integrations, agency branding and production diagnostics.

DOCUMENTATION

Overview

Introduction to BeastThemes AI Agent for WooCommerce Pro and the Agency Addon

BeastThemes AI Agent for WooCommerce combines AI support, product and order assistance, knowledge retrieval, bookings, channels, automations, integrations, diagnostics and analytics inside WordPress. The Agency Addon adds client management, reusable deployment presets, agency controls and white-label branding.

DOCUMENTATION

Requirements & Installation

Before you begin

Installation

Install and activate BeastThemes AI Agent for WooCommerce Pro first. The Agency Addon is designed to work with the existing Pro entitlement. After activation, open the plugin's admin area and work through Settings before configuring optional modules such as channels, external booking adapters and automations.

Quick start

  1. Configure the AI provider and API key.
  2. Add your business name and description.
  3. Configure RAG and run indexing if you want site knowledge.
  4. Enable WooCommerce-specific abilities when needed.
  5. Configure the chat widget and test a storefront question.
  6. Add bookings, voice, channels, automations or integrations after the basic chat flow is working.
DOCUMENTATION

Pro → Settings

Core AI configuration

The main Settings screen contains the AI provider, business context, Embedding / RAG, Booking System, Widget Appearance, WooCommerce Order Status, Voice Mode and Data controls.

Setup steps

  1. Open the plugin admin area and select Settings.
  2. Configure the AI provider, model and LLM API key.
  3. Add your Business Name and optional Description.
  4. Configure Embedding / RAG if you want indexed site knowledge.
  5. Enable Booking System and define services when appointments are required.
  6. Configure Widget Appearance, Order Status and Voice Mode as needed.
  7. Review the Data option and click Save Settings.
Recommended order: Configure AI → Business Context → RAG → Bookings → Widget → Voice → Data. Optional modules such as channels, integrations and automations can then be configured from their dedicated screens.
BeastThemes AI Agent for WooCommerce Pro — Settings: AI Provider, Business Context and Embedding / RAG
BeastThemes AI Agent for WooCommerce Pro — Settings: AI Provider, Business Context and Embedding / RAG Click to enlarge
DOCUMENTATION

AI Provider & Business Context

Connect the model and define your business

Choose the AI provider and model, then provide the provider API key. Business Context lets you supply the business name and description that can be used by the agent when responding. Keep API credentials private and never expose them in frontend content.

BeastThemes AI Agent for WooCommerce Pro — Settings: AI Provider, Business Context and Embedding / RAG
BeastThemes AI Agent for WooCommerce Pro — Settings: AI Provider, Business Context and Embedding / RAG Click to enlarge
DOCUMENTATION

Embedding / RAG

Index site knowledge for retrieval

The Embedding / RAG area lets you select an embedding provider and model, optionally provide a separate embedding API key, and control the background batch size. The screen also shows indexing status and provides a full-site re-index action.

Setup steps

  1. Select the embedding provider.
  2. Enter an embedding API key if a separate key is required.
  3. Choose the embedding model.
  4. Set a suitable background batch size for your hosting environment.
  5. Use Queue Full Site Re-index to rebuild the index.
  6. Monitor Indexed items, Queued items and Last indexed status.
BeastThemes AI Agent for WooCommerce Pro — Settings: AI Provider, Business Context and Embedding / RAG
BeastThemes AI Agent for WooCommerce Pro — Settings: AI Provider, Business Context and Embedding / RAG Click to enlarge
DOCUMENTATION

WooCommerce

Product, order and store abilities

BeastThemes AI Agent for WooCommerce can use WooCommerce-specific abilities for product lookup, order status, coupons, store information and payment links when the required configuration is available.

Common abilities

  • Product search and recommendations.
  • Secure order-status lookup with customer verification.
  • Coupon validity lookup.
  • Store information lookup.
  • Stripe/PayPal payment-link generation when configured.
Requirement: WooCommerce must be active for WooCommerce-specific product and order features. Basic chat and FAQ functionality can still operate without WooCommerce.
DOCUMENTATION

Booking System

Create bookable services

Enable bookings to allow the AI agent to create appointments. Each bookable service can have its own name, duration and daily availability. Add multiple services when different appointment types require different schedules.

Setup steps

  1. Enable bookings.
  2. Add a bookable service.
  3. Enter the service name customers will see.
  4. Set the appointment duration in minutes.
  5. Set daily availability using the 24-hour format.
  6. Add additional services when needed.
  7. Save the main plugin settings.
BeastThemes AI Agent for WooCommerce Pro — Booking System, Widget Appearance and WooCommerce Order Status
BeastThemes AI Agent for WooCommerce Pro — Booking System, Widget Appearance and WooCommerce Order Status Click to enlarge
DOCUMENTATION

Widget Appearance

Configure the storefront chat experience

Set the widget position, primary color and welcome message. The storefront widget is the customer-facing entry point for AI conversations and can expose product, order, booking and voice actions according to the enabled configuration.

BeastThemes AI Agent for WooCommerce Pro — Booking System, Widget Appearance and WooCommerce Order Status
BeastThemes AI Agent for WooCommerce Pro — Booking System, Widget Appearance and WooCommerce Order Status Click to enlarge
DOCUMENTATION

Voice Mode

Enable speech-to-text and text-to-speech

Voice Mode can expose voice controls in the widget. The supplied configuration supports browser/default speech services and OpenAI speech models, with separate STT/TTS model and voice settings plus an optional voice API key.

Setup steps

  1. Enable Voice to expose voice controls in the widget.
  2. Choose the speech-to-text provider.
  3. Choose the STT model when an API provider is used.
  4. Choose the text-to-speech provider.
  5. Choose the TTS model and voice.
  6. Optionally provide a separate Voice API key.
  7. Save Settings and test the widget microphone/audio controls.
BeastThemes AI Agent for WooCommerce Pro — Voice Mode and Data settings
BeastThemes AI Agent for WooCommerce Pro — Voice Mode and Data settings Click to enlarge
DOCUMENTATION

Data & Manual FAQs

Manage persistence and manual answers

The Data section controls whether plugin data is deleted during uninstall. Manual FAQs provide a simple question-and-answer knowledge layer with search, pagination, deletion and an Add FAQ form.

BeastThemes AI Agent for WooCommerce Pro — Manual FAQs
BeastThemes AI Agent for WooCommerce Pro — Manual FAQs Click to enlarge
DOCUMENTATION

System Health

Check runtime and AI health

System Health presents high-level request, success, latency and health-check metrics, followed by detailed checks for PHP, WordPress, WooCommerce, database tables, scheduled jobs, AI provider configuration, RAG embeddings and activity logging. AI usage by provider is shown below.

BeastThemes AI Agent for WooCommerce Pro — System Health and AI usage
BeastThemes AI Agent for WooCommerce Pro — System Health and AI usage Click to enlarge
DOCUMENTATION

Extensions / Phase 4

Optional capability packs and adapters

The Extensions screen groups optional capability packs and routing features. The supplied UI shows Restaurant Pack, Agency/Services Pack, Real Estate Pack, Smart Router LLM classification, SMS Channel, Instagram DM and External Booking Adapters as independently gated options.

BeastThemes AI Agent for WooCommerce Pro — Extensions / Phase 4 capability packs
BeastThemes AI Agent for WooCommerce Pro — Extensions / Phase 4 capability packs Click to enlarge
DOCUMENTATION

External Booking Adapters

Connect supported booking systems

External Booking Plugins provides adapter configuration for Amelia, MotoPress Hotel Booking, Bookly and Modern Events Calendar. Depending on the adapter, configuration can include API credentials, service/accommodation/event mappings, durations and booking-form handoff URLs. Credentials remain server-side according to the UI guidance.

Security: Keep API keys, secrets and consumer credentials server-side. The UI explicitly indicates that credentials are not exposed to the storefront widget.
BeastThemes AI Agent for WooCommerce Pro — External Booking Plugins
BeastThemes AI Agent for WooCommerce Pro — External Booking Plugins Click to enlarge
DOCUMENTATION

Automations

Build trigger → condition → action workflows

Create automations by defining a name, trigger, optional condition key, condition operator/value, action and action settings. The screen supports scheduled triggers through a schedule interval, and workflows can be enabled or disabled. Created workflows are listed with status, runs and last-run information.

Setup steps

  1. Enter a workflow name.
  2. Choose the trigger.
  3. Optionally define a condition key.
  4. Set the condition operator and value.
  5. Choose an action and fill its action settings.
  6. Add a schedule interval when using a scheduled trigger.
  7. Leave Enabled active and create the automation.
BeastThemes AI Agent for WooCommerce Pro — Automations
BeastThemes AI Agent for WooCommerce Pro — Automations Click to enlarge
DOCUMENTATION

Integrations

Connect external services

The Integrations screen supports configurable connections such as Generic Webhook and fields used by Slack, Zapier, Make, Stripe, PayPal and external booking webhooks. Save the integration and activate it when ready. Payment credentials and webhook URLs should be treated as sensitive configuration.

Setup steps

  1. Choose an integration type.
  2. Give the connection a recognizable label.
  3. Enter the webhook URL or service credentials required by the selected integration.
  4. Configure Stripe or PayPal credentials when applicable.
  5. Enable the integration.
  6. Save the integration and test the connected workflow.
Security: Treat webhook URLs, Stripe secrets and PayPal credentials as sensitive values. Do not publish them in screenshots or documentation.
BeastThemes AI Agent for WooCommerce Pro — Integrations
BeastThemes AI Agent for WooCommerce Pro — Integrations Click to enlarge
DOCUMENTATION

Activity Logs

Trace requests and troubleshoot failures

Activity Logs records diagnostic events and exposes totals for events, today's activity, warnings and errors. Search and level filters help narrow traces. The workflow guidance recommends following permission → request → agent routing → booking / FAQ / product / RAG / LLM → response → conversation log to locate the first failure.

Setup steps

  1. Send a test message through the storefront widget.
  2. Open Activity Logs and locate the newest chat_request trace.
  3. Open Details for the trace.
  4. Follow the workflow stages in sequence.
  5. Find the first error or unexpected status; that event is the primary troubleshooting target.
Fast troubleshooting path: permission → request → agent routing → booking / FAQ / product / RAG / LLM → response → conversation log.
BeastThemes AI Agent for WooCommerce Pro — Activity Logs
BeastThemes AI Agent for WooCommerce Pro — Activity Logs Click to enlarge
DOCUMENTATION

Pro → White-Label Mode

Base white-label configuration

The Pro white-label screen lets an Agency-tier installation hide BeastThemes AI Agent for WooCommerce branding and configure a display name and logo URL. Save the settings to apply the identity to supported surfaces.

BeastThemes AI Agent for WooCommerce Pro — Pro White-Label Mode
BeastThemes AI Agent for WooCommerce Pro — Pro White-Label Mode Click to enlarge
DOCUMENTATION

Channel Connections

Connect Telegram, WhatsApp, SMS and Instagram DM

Channel Connections normalizes incoming messages into the same agent, knowledge, booking and ability pipeline used by the web widget. The supplied UI includes Telegram bot credentials and webhook configuration, WhatsApp access and app credentials, SMS inbound/outbound webhook fields, and Instagram account configuration.

Setup steps

  1. Choose the channel you want to connect.
  2. Enter the required credentials.
  3. Configure the channel webhook using the URL shown by the plugin.
  4. Save the configuration.
  5. Send a test inbound message and verify the conversation is routed through the same agent pipeline.
BeastThemes AI Agent for WooCommerce Pro — Channel Connections
BeastThemes AI Agent for WooCommerce Pro — Channel Connections Click to enlarge
DOCUMENTATION

AI Agent Roles

Create role-based agents

AI Agent Roles lets you create specialized agents with a name, persona/system prompt, allowed abilities, optional widget instance, channel and enabled state. Allowed abilities shown in the UI include FAQ / Knowledge, Order Status and Booking. Configured agents can then be reviewed and edited from the table.

Setup steps

  1. Enter an agent name.
  2. Write the Persona / System Prompt.
  3. Select the abilities the agent is allowed to use.
  4. Optionally provide a Widget Instance identifier.
  5. Choose the channel.
  6. Enable the agent and create it.
  7. Review the Configured Agents table and edit or delete agents as needed.
BeastThemes AI Agent for WooCommerce Pro — AI Agent Roles
BeastThemes AI Agent for WooCommerce Pro — AI Agent Roles Click to enlarge
DOCUMENTATION

AI Agent Analytics

Measure operational performance

Analytics provides selectable reporting windows and summary metrics including diagnostic events, errors, average response time, conversations, resolution rate, unresolved exchanges and booking conversations. Operational breakdowns show event and endpoint counts, while Top unanswered questions highlights recurring customer questions.

BeastThemes AI Agent for WooCommerce Pro — AI Agent Analytics
BeastThemes AI Agent for WooCommerce Pro — AI Agent Analytics Click to enlarge
DOCUMENTATION

Frontend AI Chat Widget

Customer-facing experience

The storefront widget provides a branded conversation panel with online state, quick actions such as Show products and Track my order, text input, emoji, microphone and audio controls, send action and the configured brand label. Its exact available controls depend on the enabled Pro configuration.

BeastThemes AI Agent for WooCommerce Pro — Frontend AI Chat Widget
BeastThemes AI Agent for WooCommerce Pro — Frontend AI Chat Widget Click to enlarge
DOCUMENTATION

Agency Addon → Dashboard

Manage agency deployments from one place

The Agency Dashboard provides an overview of clients, presets, conversations and bookings, plus shortcuts for white-label branding, client management, deployment presets and agency controls. The entitlement panel shows the Agency license source, branding state and managed-client count.

Setup steps

  1. Confirm the Agency entitlement is active.
  2. Review client, preset, conversation and booking counts.
  3. Use the dashboard shortcuts to open branding, clients, presets or controls.
  4. Use the entitlement panel to verify branding and managed-client status.
AGENCY EDITION
Agency entitlement: The screenshots show the Agency Addon using the existing Pro entitlement rather than an arbitrary local license key.
Agency Addon — Agency Dashboard
Agency Addon — Agency Dashboard Click to enlarge
DOCUMENTATION

Agency Clients

Maintain client/site records

Agency Clients provides a lightweight inventory of managed customers and sites. Add a client with name, website, email, status and notes, then manage existing records with Edit and Delete actions.

Setup steps

  1. Enter the client name.
  2. Add the client website and email.
  3. Choose the status.
  4. Add internal notes if needed.
  5. Click Add Client.
  6. Use Edit or Delete to manage existing client records.
Agency entitlement: The screenshots show the Agency Addon using the existing Pro entitlement rather than an arbitrary local license key.
Agency Addon — Agency Clients
Agency Addon — Agency Clients Click to enlarge
DOCUMENTATION

Agency Presets

Reuse configurations for client deployments

Create reusable presets with a name, description, LLM model, welcome message and feature flags for RAG, booking and voice. Saved presets appear in the Saved presets area and can serve as starting points for repeat deployments.

Setup steps

  1. Enter a preset name.
  2. Add a description for the deployment use case.
  3. Choose the LLM model.
  4. Set the welcome message.
  5. Enable RAG, Booking and Voice according to the intended deployment.
  6. Click Create Preset and verify it appears in Saved presets.
Agency entitlement: The screenshots show the Agency Addon using the existing Pro entitlement rather than an arbitrary local license key.
Agency Addon — Agency Presets
Agency Addon — Agency Presets Click to enlarge
DOCUMENTATION

Agency White-Label Branding

Brand the supported storefront surfaces

Agency White-Label Branding synchronizes its identity settings with BeastThemes AI Agent for WooCommerce Pro's white-label configuration. Enable white-labeling, set the display name, logo URL, icon URL, support URL and documentation URL, then save Agency Branding. The preview area shows the stored identity.

Setup steps

  1. Enable white-label branding.
  2. Enter the display name.
  3. Add the logo URL and optional icon URL.
  4. Add support and documentation URLs.
  5. Click Save Agency Branding.
  6. Confirm the identity in Branding preview.
Agency entitlement: The screenshots show the Agency Addon using the existing Pro entitlement rather than an arbitrary local license key.
Agency Addon — White-Label Branding
Agency Addon — White-Label Branding Click to enlarge
DOCUMENTATION

Agency Settings

Control agency modules

Agency Settings lets administrators enable or disable Agency modules without changing Pro's core settings. The supplied UI includes Client management, Deployment presets and Deployment tools. The entitlement section shows the current Pro tier, Agency entitlement state and license source.

Setup steps

  1. Review the available Agency modules.
  2. Enable Client management when maintaining client/site records.
  3. Enable Deployment presets for reusable configurations.
  4. Enable Deployment tools when using deployment workflows.
  5. Click Save Agency Settings.
  6. Review the License entitlement panel.
Agency entitlement: The screenshots show the Agency Addon using the existing Pro entitlement rather than an arbitrary local license key.
Agency Addon — Agency Settings
Agency Addon — Agency Settings Click to enlarge
REFERENCE

Security & Data

Protect credentials, customer data and operational logs

BeastThemes AI Agent for WooCommerce stores configuration and operational data used by the agent, knowledge, booking, channel and diagnostics features. Treat API keys, access tokens, webhook secrets, payment credentials and booking credentials as sensitive configuration.

Credential handling

  • Keep LLM, embedding, voice, Telegram, WhatsApp, SMS, Instagram and external booking credentials private.
  • Do not publish API keys, webhook secrets or payment credentials in screenshots, documentation or support tickets.
  • Use the plugin's server-side configuration fields rather than exposing secrets in storefront JavaScript.
  • Use separate credentials for development/testing and production where your provider supports it.

Uninstall & data retention

The Data section includes an option to delete plugin data on uninstall. Decide on the desired retention policy before removing the plugin, especially when conversations, FAQs, embeddings, bookings or diagnostics are important to your business.

Important: The supplied UI documents the available settings, but it does not define a complete legal/privacy policy. Configure WordPress, hosting, AI providers and connected services according to your own privacy and retention requirements.
REFERENCE

Troubleshooting

Find and isolate configuration and workflow failures

1. Start with System Health

Open System Health and confirm the environment checks are passing. Review PHP, WordPress, WooCommerce, HPOS, database tables, scheduled jobs, AI provider configuration, RAG status and activity logging.

2. Reproduce the problem

  1. Send one test message through the storefront widget or connected channel.
  2. Record the exact customer request and expected result.
  3. Open Activity Logs and locate the newest chat_request trace.
  4. Open the trace details and follow the workflow from permission through response.

3. Follow the workflow stages

Use the diagnostic sequence shown in the Activity Logs UI: permission → request → agent routing → booking / FAQ / product / RAG / LLM → response → conversation log. The first red/error event is the best starting point for investigation.

Common checks

  • AI response failure: verify provider, model and LLM API key.
  • RAG returns nothing: check embedding provider/model and indexing status, then run a site re-index if required.
  • Booking does not work: confirm bookings are enabled, services have valid duration/availability, and external adapters are configured when used.
  • Voice does not work: verify Voice Mode is enabled and browser/provider speech settings are compatible.
  • Channel messages do not arrive: verify webhook URLs, provider credentials, webhook secrets and channel configuration.
  • Agency features are unavailable: verify the Agency entitlement and module switches.
Diagnostic principle: reproduce first, inspect the newest trace, then fix the earliest failing stage rather than changing multiple settings at once.
REFERENCE

Production Checklist

A practical final review before launching an AI agent

Core configuration

  • ☐ Confirm WordPress and WooCommerce are supported and healthy.
  • ☐ Select the intended AI provider and production model.
  • ☐ Add and verify the LLM API key.
  • ☐ Set the business name and business description.
  • ☐ Review the embedding provider/model and indexing status.

Knowledge & commerce

  • ☐ Add important Manual FAQs.
  • ☐ Run a full site re-index when using RAG.
  • ☐ Test product questions and product discovery.
  • ☐ Enable secure order lookup if customers need order status.

Bookings

  • ☐ Enable bookings when appointments are offered.
  • ☐ Define each bookable service, duration and daily availability.
  • ☐ Test appointment creation end-to-end.
  • ☐ If using an external booking system, configure and test the correct adapter and booking handoff.

Channels & voice

  • ☐ Test the web widget.
  • ☐ Test each enabled Telegram, WhatsApp, SMS or Instagram DM connection.
  • ☐ Verify webhook delivery and secrets.
  • ☐ Test microphone/STT/TTS functionality if Voice Mode is enabled.

Monitoring & launch

  • ☐ Review System Health.
  • ☐ Send representative test conversations and inspect Activity Logs.
  • ☐ Review Analytics for errors, unresolved exchanges and unanswered questions.
  • ☐ Confirm white-label branding, support and documentation links.
  • ☐ For agencies, verify client records, presets, modules and entitlement.
29

Developer reference

Frontend shortcode, REST endpoints, extension points and package structure

Frontend shortcode

[woo_ai_agent]
[woo_ai_agent id="support"]

REST endpoints

EndpointMethodPurpose
/wp-json/woo-ai-agent/v1/sessionGETPublic storefront session.
/wp-json/woo-ai-agent/v1/chatPOSTPublic storefront chat.
/wp-json/woo-ai-agent/v1/voice/transcribePOSTVoice transcription.
/wp-json/woo-ai-agent/v1/voice/speakPOSTText-to-speech.
/wp-json/woo-ai-agent/v1/telegram-webhookPOSTTelegram webhook.
/wp-json/woo-ai-agent/v1/whatsapp-webhookGET/POSTWhatsApp webhook/verification.
/wp-json/woo-ai-agent/v1/sms-webhookPOSTSMS inbound webhook.
/wp-json/woo-ai-agent/v1/instagram-webhookPOSTInstagram webhook.

Useful extension points present in the package

  • woo_ai_agent_license_tier — Pro licensing tier filter.
  • woo_ai_agent_agency_entitlement — Agency entitlement bridge.
  • woo_ai_agent_agency_branding_active — Agency branding activation filter.
  • woo_ai_agent_admin_branding — Agency admin branding customization filter.
  • woo_ai_agent_external_booking_availability and woo_ai_agent_external_create_booking — external booking bridge points used by the booking architecture.

Package structure

Core areas include includes/api, includes/abilities, includes/knowledge, includes/bookings, includes/channels, includes/automation, includes/integrations, includes/agents, includes/voice and includes/admin.

REFERENCE

FAQ

Frequently asked setup and usage questions

What is BeastThemes AI Agent for WooCommerce?

BeastThemes AI Agent for WooCommerce is an AI-powered support and commerce assistant for WooCommerce, with configurable knowledge/RAG, product and order assistance, booking, voice, channels, agents, automations, integrations and diagnostics.

Does it support bookings?

Yes. The Pro configuration includes an internal Booking System where you can define services, duration and daily availability. External booking adapters can connect supported systems such as Amelia, MotoPress Hotel Booking, Bookly and Modern Events Calendar.

Can customers track orders?

Yes. The interface includes a WooCommerce Order Status capability for secure customer order lookup, and Order Status can also be granted as an ability to an AI Agent Role.

Can I use my own AI provider key?

The settings screen is designed around a selected AI provider, model and LLM API key. The supplied configuration specifically shows OpenAI and notes that the embedding API key can reuse the LLM key when OpenAI embeddings are selected.

What is RAG used for?

RAG adds an indexed knowledge layer that the agent can retrieve from. The settings expose embedding provider/model configuration, background batch size and indexing status, including a full site re-index action.

Can I create multiple specialized agents?

Yes. AI Agent Roles supports multiple configured agents with different personas, abilities, channels and optional widget instances.

Can I connect Telegram or WhatsApp?

Yes. Channel Connections provides dedicated configuration for Telegram and WhatsApp, along with SMS and Instagram DM sections. Each provider requires its own credentials and webhook configuration.

What does the Agency Addon provide?

The Agency Edition adds client management, reusable deployment presets, agency module controls and white-label branding, while using the existing Pro entitlement shown in the supplied screens.

Where should I look when something fails?

Start with System Health, reproduce the issue, then inspect the newest Activity Logs trace and identify the first failing workflow stage.

How do I get support?

Use the support URL configured in the white-label/agency branding settings or the support process provided with your BeastThemes purchase.