VertexBot Documentation

Introduction to VertexBot

Welcome to VertexBot, the intelligent AI-powered chatbot platform designed to transform your website's user engagement and drive sales. This documentation provides a comprehensive overview of how to get started, from installation to advanced configuration.

Installation Guide

Integrating VertexBot into your website is a simple, two-step process:

1. Whitelist Your Domain: Before the chatbot can work, you must tell it which websites it's allowed to run on. Go to the Installation Page in your dashboard and add your website's domain (e.g., yourwebsite.com).
2. Copy & Paste the Script: On the same Installation Page, you'll find a unique JavaScript snippet. Copy this code and paste it just before the closing tag on every page of your website where you want the chatbot to appear.

Dashboard Overview

The VertexBot Dashboard is your central command center for managing every aspect of your chatbot. Here’s a breakdown of each page and its function:

Home Page

This is your main landing page after logging in. It provides an at-a-glance view of your bot's performance and core settings.

• Statistics: Key metrics like total orders, conversations, and more. You can filter these stats by date range.
• Bot Settings: Configure your bot's core personality, knowledge base, appearance (colors, name, avatar), and behavior (welcome message style, purchase handling).
• FAQs: Add frequently asked questions to make your bot more accurate.
• Installation Code: A quick access point for your unique installation script.

Products Page

This section allows you to manage the products your chatbot is aware of. The bot uses this information to answer customer questions and make recommendations.

• Add/Edit Products: Define product name, description, price, and a direct URL.
• Currency: Set the currency for your store (e.g., USD, EGP, SAR).
• SEO Impact: Keeping product URLs updated helps the bot drive traffic to the correct pages, improving your site's internal linking structure.

My Orders Page

When the chatbot successfully captures a lead with purchase intent, the order appears here. This page is crucial for managing your sales pipeline.

• View Orders: See all collected orders with customer details (name, phone, address) and product of interest.
• Manage Status: Update the status of each order (e.g., New, Pending, Shipped, Canceled).
• Filter & Export: Filter orders by date and export your data to an Excel (CSV) file for external analysis.

Conversations Page

Review every interaction customers have with your chatbot. This is an invaluable tool for understanding customer needs and improving your bot's knowledge base.

• Chat History: Read full transcripts of conversations.
• Filter & Manage: Filter conversations by date range, mark important ones with a star, and delete irrelevant entries.

Policies Page

Educate your chatbot on your store's official policies. This ensures it provides consistent and accurate information to customers, building trust.

• Define Policies: Add your Shipping, Return & Refund, and Payment policies.
• How it Works: The bot integrates this text directly into its knowledge base. When a customer asks about returns, for example, the bot will use the exact information you provided.

Integrations Page

This page provides your unique API key, allowing you to connect VertexBot to other systems.

• API Key: Use this key to programmatically add products to your bot's knowledge base from external platforms (e.g., an inventory management system).
• Usage Example: The page includes a clear code example for how to make a `POST` request to the `addProductViaAPI` endpoint.

My Plan & Billing

Manage your subscription and monitor your usage quotas.

• My Plan: View your current plan, and track your usage of conversations, orders, websites, and products against your quota.
• Billing: Securely upgrade your plan through our Stripe integration. You can also cancel your subscription from this section.

Support Page

If you encounter any issues or have questions, you can submit a support ticket directly through the dashboard. Our team will get back to you via email.