Platform Requirements

System dependencies, host hardware resources, network ports configuration, database structures, and third-party API credentials needed to deploy WhatsOmni.

WhatsOmni runs on a high-concurrency multi-tier architecture, utilizing Laravel 11 (PHP 8.2+), Next.js 15 (App Router), Laravel Reverb WebSockets, Redis queues, and Node.js Baileys microservices to coordinate omnichannel messaging gateways, AI agents, visual flow automation, and multi-tenant CRM operations. Ensure your deployment host meets the resource limits and connectivity conditions listed below.

System & Service Specifications

The following table lists the physical resources, database software configurations, and runtime dependencies required to launch the WhatsOmni application stack:

Branding & White-Labeling

Learn how to fully white-label WhatsOmni, update platform brand names, upload custom logos and favicons, configure color design tokens, and customize transactional email templates.

Super Admin Platform Customization

WhatsOmni provides an intuitive, real-time GUI for platform Super Admins under Super Admin Panel → Settings → Customization (/superadmin/settings/customization). Changes made here instantly synchronize across the entire application stack:

Code-Level Configuration & Fallback Tokens

To hardcode default brand settings, fallback logos, and style tokens directly in the codebase before deploying, update the configuration file located at frontend/src/config/branding.ts:

export const BRANDING_CONFIG = {
  // Core branding configurations
  defaultName: 'WhatsOmni',
  defaultLogo: '/logo.svg',
  defaultPrimaryColor: '#4AE54A',
  defaultAccentColor: '#0A0A0A',
  defaultDomain: 'whatsomni.com',
  defaultSupportEmail: 'support@whatsomni.com',

  // UI styling tokens (dynamic runtime injects)
  styleTokens: {
    accentGreen: '#4AE54A',
    accentGreenHover: '#3DD43D',
    borderFocus: '#0A0A0A',
    fgPrimary: '#0A0A0A',
  },

  // Copywriting details
  landing: {
    description: 'Bring every conversation into one place. Unified inbox, visual automations, AI agents, and CRM sync.',
    trademarkSymbol: '™',
    copyrightSuffix: 'All rights reserved.',
    sslTag: 'Secure SSL Encrypted',
  }
};

Dynamic Runtime Theme Engine

WhatsOmni uses a centralized React Context Provider (BrandingThemeProvider.tsx) that wraps the entire application. On initial load, it fetches public branding settings from GET /platform/settings and injects the following CSS custom properties onto the :root element:

Tenant Workspace & Client Channel Customization

In addition to platform-level white-labeling, individual B2B tenants can personalize their workspace and client-facing communication channels:

Download & Unzip the Package

Extract the WhatsOmni platform release archive and inspect the repository architecture.

The WhatsOmni software distribution package contains the complete multi-tenant platform, including the Laravel 11 backend REST API, Next.js 15 frontend web application, Baileys WhatsApp microservice, Docker container configurations, and database migration schemas. Extract the archive onto your local workstation or server host to get started.

Package Contents & Repository Layout

Once extracted, your root project directory will contain the following primary folders and configuration manifests:

Extracting the Package via Terminal

Execute the following terminal commands to extract the release archive and switch into the project root directory:

unzip whatsomni.zip -d whatsomni-saas
cd whatsomni-saas

Setup MySQL Database & Redis

Create the MySQL 8.0 relational database schema and verify the in-memory Redis message broker connection.

WhatsOmni relies on MySQL 8.0 (or MariaDB 10.11+) with full utf8mb4 multibyte character support to store multi-tenant records, visual flow graphs, and message transcripts. In-memory Redis is used as the asynchronous queue broker and WebSockets cache store.

Create MySQL Database

Log in to your MySQL terminal client or server CLI and create the dedicated database instance with strict UTF-8 collation:

mysql -u root -p -e "CREATE DATABASE whatsomni_db CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"

Verify Redis Service Connection

Ensure that the Redis server daemon is running and listening on default port 6379:

redis-cli ping
# Expected response: PONG

Using Graphical Database Clients

If you prefer a visual database manager to inspect tables or manage database instances, use any of the following tools:

Install Required Dependencies

Download and install PHP Composer packages for Laravel 11 and NPM dependencies for Next.js 15 and Baileys worker.

WhatsOmni is architected with modern modular services. Follow the steps below to verify your local CLI runtimes and install required third-party packages for all three layers.

Verify CLI Runtimes

Verify that your system meets the minimum runtime version constraints before proceeding with package installation:

php -v        # Must be PHP 8.2 or 8.3
composer -v   # PHP Dependency Manager
node -v       # Must be Node.js 18.18+ or 20.x LTS
npm -v        # Node Package Manager

Install Backend PHP Dependencies

Navigate to the backend/ directory and install Composer dependencies with optimized class mapping:

cd backend
composer install --optimize-autoloader

Install Frontend Next.js Dependencies

Switch to the frontend/ directory and install Node.js modules for the React 19 client and UI components:

cd ../frontend
npm install

Install WhatsApp Baileys Worker Dependencies

Switch to the baileys-worker/ microservice directory and install its required WebSocket and cryptography packages:

cd ../baileys-worker
npm install

Core Package Breakdown

Set Up Configuration Files (.env)

Create your environment settings files to connect database tables, Redis queues, Reverb WebSockets, and external APIs.

Both frontend and backend services utilize standardized .env files to manage runtime environment variables, database credentials, WebSocket broadcast ports, and security encryption keys.

Copy Environment Templates

Run the following commands from the root directory to generate active settings files from templates:

# 1. Copy backend environment configuration
cp backend/.env.example backend/.env

# 2. Copy frontend Next.js environment configuration (.env.local or .env)
cp frontend/.env.example frontend/.env.local

# 3. Copy WhatsApp Baileys microservice environment configuration
cp baileys-worker/.env.example baileys-worker/.env

Generate Application Key & Run Migrations

Generate the Laravel 32-byte AES encryption key, create the public storage symbolic link, and execute the database migration and seeder suite:

cd backend
php artisan key:generate
php artisan storage:link
php artisan migrate --seed

Backend Configuration Parameters (backend/.env)

Backend Template File (backend/.env.example)

The complete template manifest provided in the backend/ directory:

APP_NAME=WhatsOmni
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_TIMEZONE=UTC
APP_URL=http://localhost:8000
FRONTEND_URL=http://localhost:3000,http://localhost:3001,http://127.0.0.1:3000,http://127.0.0.1:3001
SANCTUM_STATEFUL_DOMAINS=localhost:3000,localhost:3001,127.0.0.1:3000,127.0.0.1:3001

APP_LOCALE=en
APP_FALLBACK_LOCALE=en
APP_FAKER_LOCALE=en_US

APP_MAINTENANCE_DRIVER=file
# APP_MAINTENANCE_STORE=database

PHP_CLI_SERVER_WORKERS=4

BCRYPT_ROUNDS=12

LOG_CHANNEL=stack
LOG_STACK=single
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug

# Database Configuration (MySQL / PostgreSQL / SQLite)
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=whatsomni
DB_USERNAME=root
DB_PASSWORD=

# Session Configuration
SESSION_DRIVER=file
SESSION_LIFETIME=120
SESSION_ENCRYPT=false
SESSION_PATH=/
SESSION_DOMAIN=null

# Broadcasting, Filesystem & Queues
BROADCAST_CONNECTION=reverb
FILESYSTEM_DISK=local
QUEUE_CONNECTION=sync

# Cache Configuration
CACHE_STORE=database
CACHE_PREFIX=

MEMCACHED_HOST=127.0.0.1

# Redis Configuration
REDIS_CLIENT=phpredis
REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

VITE_APP_NAME="${APP_NAME}"

# Laravel Reverb (Realtime WebSocket Server)
REVERB_APP_ID=your_reverb_app_id
REVERB_APP_KEY=your_reverb_app_key
REVERB_APP_SECRET=your_reverb_app_secret
REVERB_HOST="localhost"
REVERB_PORT=8080
REVERB_SCHEME=http

VITE_REVERB_APP_KEY="${REVERB_APP_KEY}"
VITE_REVERB_HOST="${REVERB_HOST}"
VITE_REVERB_PORT="${REVERB_PORT}"
VITE_REVERB_SCHEME="${REVERB_SCHEME}"

# Meilisearch Scout Vector & Full-Text Search (Knowledge Base)
SCOUT_DRIVER=meilisearch
MEILISEARCH_HOST=http://127.0.0.1:7700
MEILISEARCH_KEY=masterKey123

# Google Sheets & Google OAuth Integration
GOOGLE_CLIENT_ID=your_google_client_id.apps.googleusercontent.com
GOOGLE_CLIENT_SECRET=your_google_client_secret
GOOGLE_REDIRECT_URI=http://localhost:8000/api/integrations/google/callback

# HubSpot CRM Integration
HUBSPOT_CLIENT_ID=your_hubspot_client_id
HUBSPOT_CLIENT_SECRET=your_hubspot_client_secret

# Salesforce CRM Integration
SALESFORCE_CLIENT_ID=dummy-client-id-for-salesforce-crm
SALESFORCE_CLIENT_SECRET=dummy-client-secret-for-salesforce-crm

# Zoho CRM Integration
ZOHO_CLIENT_ID=dummy-client-id-for-zoho-crm
ZOHO_CLIENT_SECRET=dummy-client-secret-for-zoho-crm

# Zoom Integration
ZOOM_CLIENT_ID=your_zoom_client_id
ZOOM_CLIENT_SECRET=your_zoom_client_secret
ZOOM_REDIRECT_URI=http://localhost:8000/api/integrations/zoom/callback

# Microsoft Teams Integration
TEAMS_CLIENT_ID=your_teams_client_id
TEAMS_CLIENT_SECRET=your_teams_client_secret
TEAMS_REDIRECT_URI=http://localhost:8000/api/integrations/teams/callback

# Mail & Resend Configuration
MAIL_MAILER=smtp
MAIL_HOST=127.0.0.1
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="hello@whatsomni.com"
MAIL_FROM_NAME="${APP_NAME}"
RESEND_KEY=
RESEND_API_KEY=

# AI Provider API Keys (Optional defaults / managed via SuperAdmin DB)
OPENAI_API_KEY=
GROQ_API_KEY=
ANTHROPIC_API_KEY=
GEMINI_API_KEY=

# AWS S3 Cloud Storage
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false

# Baileys WhatsApp Microservice Worker
BAILEYS_WORKER_URL=http://localhost:5001
BAILEYS_SECRET_TOKEN=whatsomni_baileys_secret_key

Frontend Configuration Parameters (frontend/.env.local)

The Next.js 15 frontend loads variables from frontend/.env.local (or frontend/.env):

Frontend Template File (frontend/.env.example)

The complete template manifest provided in the frontend/ directory:

# WhatsOmni Frontend Environment Configuration

# Backend API Base URL
NEXT_PUBLIC_BACKEND_URL=http://localhost:8000

# Realtime WebSocket Broadcasting (Laravel Reverb)
NEXT_PUBLIC_REVERB_APP_KEY=whatsomni_reverb_key
NEXT_PUBLIC_REVERB_HOST=localhost
NEXT_PUBLIC_REVERB_PORT=8080
NEXT_PUBLIC_REVERB_SCHEME=http

Baileys Microservice Configuration (baileys-worker/.env)

Baileys Worker Template File (baileys-worker/.env.example)

The complete template manifest provided in the baileys-worker/ directory:

PORT=5001
LARAVEL_API_URL=http://localhost:8000
BAILEYS_SECRET_TOKEN=whatsomni_baileys_secret_key

Start Local Application

Launch the development server stack natively across terminal tabs or using Docker Compose.

WhatsOmni can be started either natively by running development processes across separate terminal tabs or automatically with a single command via Docker Compose.

Option A: Native Multi-Terminal Startup (Manual Mode)

Open 4 separate terminal windows or tabs to run the services concurrently:

cd backend
php artisan serve --port=8000

cd backend
# Process background jobs, campaigns & AI agent tasks
php artisan queue:listen --tries=1

# In another terminal tab: Start Reverb WebSocket server
php artisan reverb:start --port=8080

cd frontend
npm run dev

cd baileys-worker
node server.js

Option B: Docker Compose Startup (1-Command)

If you have Docker Desktop or Colima installed, launch the entire containerized ecosystem using the Makefile:

# Start all containers in development mode
make dev-up

# Run migrations and initial seeders inside the container
make migrate
make seed

# Stream live container logs
make logs

Local Access Endpoints & Default Credentials

Production Live Deployment

Deploy WhatsOmni on Ubuntu 22.04 / 24.04 LTS servers with Nginx, PHP 8.3-FPM, Supervisor, PM2, and SSL encryption.

For high-availability production environments on cloud providers like DigitalOcean, AWS EC2, Hetzner, or Linode, follow this hardened production guide.

Server Provisioning & Dependencies

Connect to your clean Ubuntu 22.04 or 24.04 server via SSH and install the system packages:

# 1. Update system packages
sudo apt update && sudo apt upgrade -y

# 2. Install PHP 8.3-FPM, MySQL drivers, Redis, and extensions
sudo apt install -y php8.3-fpm php8.3-cli php8.3-mysql php8.3-mbstring \
php8.3-xml php8.3-bcmath php8.3-curl php8.3-zip php8.3-gd php8.3-sqlite3 \
php8.3-redis unzip curl git nginx supervisor redis-server

# 3. Install Composer globally
curl -sS https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer

# 4. Install Node.js 20 LTS & PM2 process manager
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install -y nodejs
sudo npm install -g pm2

Deploy Code & Configure Permissions

Clone the project repository into /var/www/whatsomni and build the backend application:

# 1. Clone repository
cd /var/www
sudo git clone <YOUR_REPOSITORY_URL> whatsomni
sudo chown -R $USER:www-data /var/www/whatsomni

# 2. Deploy Backend
cd /var/www/whatsomni/backend
composer install --no-dev --optimize-autoloader
cp .env.example .env
nano .env # Fill in production DB, APP_URL, FRONTEND_URL, and Reverb keys

# 3. Initialize Key, Storage Link & Database Migrations
php artisan key:generate
php artisan storage:link
php artisan migrate --force

# 4. Cache configurations for peak production performance
php artisan config:cache
php artisan route:cache
php artisan view:cache
php artisan event:cache

# 5. Set proper file permissions
sudo chown -R www-data:www-data storage bootstrap/cache
sudo chmod -R 775 storage bootstrap/cache

Build Frontend & Manage PM2 Services

Build the Next.js frontend production bundle and launch the microservices under PM2:

# 1. Build and Start Frontend (Port 3000)
cd /var/www/whatsomni/frontend
npm ci
cp .env.example .env.production
nano .env.production # Set NEXT_PUBLIC_BACKEND_URL and Reverb keys
npm run build
pm2 start npm --name "whatsomni-frontend" -- start -- -p 3000

# 2. Start WhatsApp Baileys Worker (Port 5001)
cd /var/www/whatsomni/baileys-worker
npm ci
cp .env.example .env
mkdir -p storage && sudo chown -R $USER:www-data storage
pm2 start server.js --name "baileys-worker"

# 3. Save PM2 state for automatic reboot persistence
pm2 save
pm2 startup

Configure Supervisor Daemons

Create dedicated Supervisor configurations to keep the Laravel Queue Worker and Reverb WebSockets permanently active:

[program:whatsomni-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /var/www/whatsomni/backend/artisan queue:work redis --sleep=3 --tries=3 --max-time=3600
autostart=true
autorestart=true
stopasgroup=true
killasgroup=true
user=www-data
numprocs=2
redirect_stderr=true
stdout_logfile=/var/www/whatsomni/backend/storage/logs/worker.log
stopwaitsecs=360

[program:whatsomni-reverb]
command=php /var/www/whatsomni/backend/artisan reverb:start --host=0.0.0.0 --port=8080
autostart=true
autorestart=true
user=www-data
redirect_stderr=true
stdout_logfile=/var/www/whatsomni/backend/storage/logs/reverb.log

sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start all

Configure System Crontab

Add the Laravel Task Scheduler to the system crontab (`sudo crontab -e -u www-data`):

* * * * * cd /var/www/whatsomni/backend && php artisan schedule:run >> /dev/null 2>&1

Nginx VirtualHost & Free Let's Encrypt SSL

Create the Nginx configuration file at /etc/nginx/sites-available/whatsomni:

# 1. Frontend SPA (yourdomain.com)
server {
    listen 80;
    server_name yourdomain.com;

    location / {
        proxy_pass http://127.0.0.1:3000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

# 2. Backend REST API & Reverb WebSockets (api.yourdomain.com)
server {
    listen 80;
    server_name api.yourdomain.com;
    root /var/www/whatsomni/backend/public;
    index index.php;

    # Reverb WebSocket Proxy
    location /app {
        proxy_pass http://127.0.0.1:8080;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_read_timeout 60s;
        proxy_send_timeout 60s;
    }

    # Laravel REST API Routing
    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    location ~ \.php$ {
        include snippets/fastcgi-php.conf;
        fastcgi_pass unix:/run/php/php8.3-fpm.sock;
        fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
        include fastcgi_params;
    }
}

sudo ln -s /etc/nginx/sites-available/whatsomni /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl reload nginx

# Issue Let's Encrypt SSL Certificates
sudo apt install -y certbot python3-certbot-nginx
sudo certbot --nginx -d yourdomain.com -d api.yourdomain.com

Payment Gateways & Global Billing

WhatsOmni provides a comprehensive billing architecture with 5 enterprise payment gateways. Platform operators can enable one or multiple gateways simultaneously, allowing global customers to subscribe using their preferred regional currencies, credit cards, mobile wallets, UPI, and instant digital payment systems.

1. Stripe Billing

Credit/debit cards, Apple Pay, Google Pay, SEPA, multi-currency subscription lifecycle, and customer billing portal.

2. PayPal Subscriptions

PayPal Vault, Smart Buttons, automated recurring subscription plans, and IPN/Webhook instant verification.

3. Razorpay

Seamless Indian payments via UPI (GPay, PhonePe, Paytm), NetBanking, RuPay/Visa/Mastercard, and automatic INR conversions.

4. Paystack

Leading African gateway for Nigeria (NGN), Ghana (GHS), South Africa (ZAR), and Kenya with recurring card charging.

5. Flutterwave

Pan-African card payments, Mobile Money (M-Pesa, MTN, Airtel Money), and global multi-currency checkout across 34+ countries.

Gateway 1: Stripe Setup & Webhooks

Gateway 2: PayPal Subscriptions Setup

Gateway 3: Razorpay Setup (India / UPI / Cards)

Gateway 4: Paystack Setup (Africa / NGN / GHS / ZAR)

Gateway 5: Flutterwave Setup (Cards & Mobile Money)

Super Admin Payment Gateways Configuration

In WhatsOmni, payment gateway credentials are not stored in static environment files. Super Admins configure each payment gateway dynamically directly in the Super Admin Control Panel → Settings → Payment Gateways (/superadmin/settings/gateways). Settings are saved encrypted in the database and apply instantly without server restarts:

Payment Gateway	Super Admin UI Fields (/superadmin/settings/gateways)	Capabilities & Webhook Endpoint
Stripe	Mode (Test / Live) Publishable Key (pk_...) Secret Key (sk_...) Webhook Secret (whsec_...)	Multi-currency credit/debit card subscriptions, Apple Pay, Google Pay. Webhook URL: https://api.yourdomain.com/api/billing/stripe/webhook
PayPal	Mode (Sandbox / Live) Client ID Client Secret Webhook ID	Global PayPal wallet payments and recurring subscription billing. Webhook URL: https://api.yourdomain.com/api/billing/paypal/webhook
Razorpay	Mode (Test / Live) Key ID (rzp_...) Key Secret Webhook Secret	Indian Rupee (INR) payments, UPI, NetBanking, and recurring mandate cards. Webhook URL: https://api.yourdomain.com/api/billing/razorpay/webhook
Paystack	Mode (Test / Live) Public Key (pk_...) Secret Key (sk_...) Webhook Secret	African payment processing across Nigeria (NGN), Ghana (GHS), South Africa (ZAR), and Kenya (KES). Webhook URL: https://api.yourdomain.com/api/billing/paystack/webhook
Flutterwave	Mode (Test / Live) Public Key (FLWPUBK_...) Secret Key (FLWSECK_...) Secret Hash / Encryption Key	Pan-African payments, Mobile Money (M-Pesa, MTN, Airtel), and international card processing. Webhook URL: https://api.yourdomain.com/api/billing/flutterwave/webhook

Google Calendar & Sheets Setup

The Google integration provides 2-way Google Calendar synchronization for multi-host appointment scheduling, busy-slot conflict detection, and real-time lead appending to Google Sheets directly from Visual Flows.

Create Google Cloud Project & Enable APIs

• Go to the Google Cloud Console and create a new project named WhatsOmni Integration.
• Navigate to APIs & Services → Library.
• Search for and enable both of the following APIs:
  • Google Calendar API
  • Google Sheets API

Configure OAuth Consent Screen & Credentials

• Navigate to APIs & Services → OAuth consent screen.
• Select External User Type and click Create.
• Fill in the Application Name (WhatsOmni), User Support Email, and Developer Contact Email.
• Add the required OAuth scopes:
  • https://www.googleapis.com/auth/calendar.events (Manage calendar appointments)
  • https://www.googleapis.com/auth/spreadsheets (Append and update rows in Google Sheets)
• Go to APIs & Services → Credentials, click Create Credentials → OAuth client ID.
• Select Web application as the Application Type.
• Under Authorized redirect URIs, add your backend callback endpoint:
  https://api.yourdomain.com/api/integrations/google/callback
• Click Create and copy the generated Client ID and Client Secret.

Google Configuration Parameters

Transactional Email (Resend & SMTP)

In WhatsOmni, transactional email dispatch is managed dynamically through the Super Admin Control Plane and stored encrypted in the database. You do not need to modify static .env files or restart backend server processes to change mail providers or update credentials.

Setup Option 1: Resend API (Recommended)

Resend provides ultra-fast delivery, real-time analytics, and verified domain reputation without legacy SMTP overhead:

• Create a free account at resend.com.
• Navigate to Domains and add your sending domain (e.g., yourdomain.com). Add the provided DKIM and SPF DNS records to your DNS provider (Cloudflare, GoDaddy, Route53, etc.).
• Go to API Keys and create an API key with Full Access permissions (starts with re_...).
• Log in to your WhatsOmni Super Admin Dashboard, navigate to Settings → Mail Configuration, and select Resend as the driver:
  • API Key: Paste your re_... API token.
  • From Address: Enter your verified sending email (e.g., notifications@yourdomain.com).
  • From Name: Enter your brand/platform name (e.g., WhatsOmni).
• Enter your personal email in the Test Recipient input and click Send Test Email to verify the connection live.
• Click Save Settings to activate.

Setup Option 2: Custom SMTP Server Relay

If you use a traditional transactional SMTP relay provider (such as Amazon SES, Postmark, SendGrid, Mailgun, Brevo, or a private Postfix server):

• Log in to your WhatsOmni Super Admin Dashboard and navigate to Settings → Mail Configuration.
• Select SMTP as the mail driver and fill in your relay parameters:
  • SMTP Host: Your mail server hostname (e.g., smtp.mailgun.org or email-smtp.us-east-1.amazonaws.com).
  • SMTP Port: 587 (for TLS / STARTTLS) or 465 (for SSL).
  • Encryption: Select TLS, SSL, or None.
  • Username: Your SMTP username or API user.
  • Password: Your SMTP password or relay secret key.
  • From Email Address: The sender address verified on your SMTP account.
  • From Sender Name: The sender display name visible in the inbox.
• Enter your email into the Test Recipient box and click Send Test Email. WhatsOmni will attempt an immediate live SMTP handshake and confirm success.
• Click Save Settings to persist your configuration.

Database Storage & Runtime Resolution

HubSpot CRM Integration

Connect HubSpot CRM to synchronize omnichannel contacts, push conversation summaries, and trigger deal pipeline creation whenever an AI chatbot or visual flow qualifies a new inbound prospect.

Create HubSpot Developer App

• Log in to your HubSpot Developer Account and click Create app.
• Enter an App Name (e.g. WhatsOmni CRM Bridge) and set up the logo and description.
• Navigate to the Auth tab and enter your callback redirect URL:
  https://api.yourdomain.com/api/integrations/crm/callback/hubspot
• Under Scopes, select the following permissions:
  • crm.objects.contacts.read & crm.objects.contacts.write
  • crm.objects.deals.read & crm.objects.deals.write
  • crm.schemas.contacts.read
• Save changes and copy the Client ID and Client Secret into your backend environment file.

HubSpot Configuration Parameters

Salesforce CRM Integration

Integrate Salesforce CRM to automatically convert high-intent WhatsApp and Instagram conversations into Salesforce Leads, update Opportunities, and trigger enterprise sales rep assignment.

Create Salesforce Connected App

• Log in to your Salesforce Setup Console (Setup → App Manager).
• Click New Connected App in the top right corner.
• Enter Connected App Name (WhatsOmni Connector) and Contact Email.
• Check Enable OAuth Settings.
• Set the Callback URL:
  https://api.yourdomain.com/api/integrations/crm/callback/salesforce
• Under Selected OAuth Scopes, add:
  • Manage user data via APIs (api)
  • Perform requests at any time (refresh_token, offline_access)
• Save the app, click Manage Consumer Details, and copy the Consumer Key (Client ID) and Consumer Secret.

Salesforce Configuration Parameters

Zoho CRM Integration

Configure Zoho CRM Server-Based Client credentials to synchronize customer contacts, manage deals, and update lead status across US, EU, and IN regional data center clusters.

Create Zoho Server-Based Application

• Visit the Zoho API Console.
• Click Add Client and choose Server-based Applications.
• Enter Client Name (WhatsOmni) and Homepage URL.
• Under Authorized Redirect URIs, enter:
  https://api.yourdomain.com/api/integrations/crm/callback/zoho
• Click Create and copy the Client ID and Client Secret from the Client Secret tab.

Zoho Configuration Parameters

Meta (WhatsApp, Instagram & Messenger)

Connect Meta for Developers to manage WhatsApp Cloud API (via seamless Embedded Signup or Manual BYOK), Facebook Page Messenger, and Instagram Direct customer inquiries, plus automated feed and reel publishing via the Social Posts Studio.

WhatsApp Cloud API: Onboarding Modes

Create Meta Business App & Permissions

• Visit developers.facebook.com → My Apps → Create App.
• Select Business as the App Type and name it WhatsOmni Suite.
• Add the WhatsApp, Messenger, and Instagram Graph API products to your app.
• Navigate to App settings → Basic, copy your App ID and App Secret.
• Under Facebook Login for Business → Configurations, create a configuration for Embedded Signup with permissions: whatsapp_business_messaging, whatsapp_business_management, pages_show_list, pages_messaging, instagram_basic, instagram_manage_messages, pages_manage_posts, instagram_content_publish.
• Under Facebook Login for Business → Settings, add the OAuth Redirect URIs:
  https://api.yourdomain.com/api/integrations/messenger/oauth/callback
https://api.yourdomain.com/api/integrations/instagram/oauth/callback
https://api.yourdomain.com/api/integrations/whatsapp/embedded/callback
• Configure Webhooks under WhatsApp & Messenger Webhooks:
  Callback URL: https://api.yourdomain.com/api/webhooks/channel/{connection_id}
  Verify Token: Set your custom secret string matching your channel setup.

Super Admin Meta & Channels Configuration

Meta credentials are not configured in static .env files. The platform administrator sets up the Meta App credentials dynamically in the Super Admin Control Panel → Settings → Meta (or Super Admin → Channels). Settings are saved encrypted in the database and loaded at runtime:

TikTok (Direct Messages & Video Kit)

Connect TikTok for Developers to manage direct customer conversations in the Unified Inbox with AI Copilot support, and schedule high-impact 9:16 short-form video posts and reels directly from the Social Posts Studio.

Create TikTok Developer App

• Visit the TikTok for Developers Portal and click Create an App.
• Add the Login Kit for Web product. Configure the Redirect URI:
  https://api.yourdomain.com/api/integrations/tiktok/oauth/callback
• Add the Direct Message API and Video Kit for Web products.
• Request the required permissions:
  • user.info.basic & user.info.profile (Account profile details)
  • im.share & Direct Messaging scopes (2-way chat synchronization)
  • video.upload & video.publish (Automated video scheduling)
• Copy your Client Key and Client Secret from App Details.
• Configure the Webhook receiver URL:
  https://api.yourdomain.com/api/webhooks/channel/{connection_id}
  Verify that your server handles TikTok's verification challenge via the tt-security-token header.

Super Admin TikTok Channel Configuration

TikTok credentials are not configured in static .env files. Super Admins configure TikTok developer credentials directly in the Super Admin Control Panel → Channels → TikTok (/superadmin/channels). Credentials are stored encrypted in the database and apply instantly:

LinkedIn (Content Publishing & Pages)

Connect LinkedIn Developer Portal to publish and schedule rich text updates, multi-image carousels, and high-definition video posts across Personal Profiles and Organization Company Pages from the WhatsOmni Social Posts Studio.

Create LinkedIn Developer App

• Sign in to the LinkedIn Developer Portal → Create App.
• Associate your LinkedIn Company Page and upload your app logo.
• Under the Products tab, add:
  • Share on LinkedIn (Enables personal member profile publishing)
  • Sign In with LinkedIn using OpenID Connect
  • Community Management API (Required for Company Page administration)
• Under the Auth tab, configure the Authorized Redirect URL:
  https://api.yourdomain.com/api/integrations/linkedin/oauth/callback
• Copy the Client ID and Primary Client Secret.

Super Admin LinkedIn Channel Configuration

LinkedIn credentials are not configured in static .env files. Super Admins configure LinkedIn developer credentials directly in the Super Admin Control Panel → Channels → LinkedIn (/superadmin/channels). Credentials are stored encrypted in the database:

Zoom Video Conferencing

Connect Zoom App Marketplace to automatically create distinct Zoom meeting links, join URLs, and passcodes whenever clients schedule appointments via staff booking pages or chatbot prompts.

Create Zoom OAuth Application

• Sign in to the Zoom App Marketplace.
• Click Develop → Build App → General App.
• Under OAuth, enter your Redirect URL:
  https://api.yourdomain.com/api/integrations/meetings/callback
• Add the required Scopes:
  • meeting:write:admin & meeting:write (Create and manage video meetings)
  • user:read:admin & user:read (Verify staff host profiles)
• Copy the Client ID and Client Secret from the App Credentials page.

Zoom Configuration Parameters

Microsoft Teams Integration

Connect Microsoft Entra ID (Azure AD) to enable corporate Microsoft 365 calendar scheduling and automatically generate Microsoft Teams video conference join links for scheduled staff consultations.

Register Application in Azure Portal

• Sign in to the Azure Portal → Microsoft Entra ID → App registrations.
• Click New registration, name it WhatsOmni Teams Integration.
• Under Supported account types, choose Accounts in any organizational directory (Multitenant) and personal Microsoft accounts.
• Set Redirect URI (Web):
  https://api.yourdomain.com/api/integrations/meetings/callback
• Go to API permissions → Add a permission → Microsoft Graph → Delegated permissions and add:
  • OnlineMeetings.ReadWrite (Create online meeting links)
  • User.Read (Access user profile)
  • offline_access (Maintain long-lived refresh tokens)
• Go to Certificates & secrets → New client secret, create a secret and copy its Value.
• Copy the Application (client) ID from the Overview tab.

Microsoft Teams Configuration Parameters

Meilisearch Vector & Knowledge Base

Meilisearch powers the AI Assistant Knowledge Base, vector embeddings, PDF document search, and real-time multi-tenant product catalog lookups with sub-50ms response times.

Install & Start Meilisearch

Install Meilisearch on Ubuntu or run via Docker:

# Download and install binary
curl -L https://install.meilisearch.com | sh
sudo mv meilisearch /usr/local/bin/

# Start Meilisearch with Master Key
meilisearch --http-addr '127.0.0.1:7700' --master-key='your_secure_master_key'

Meilisearch Configuration Parameters

Import & Index Knowledge Articles

Sync all knowledge base articles into the search engine:

php artisan scout:import "App\Models\KnowledgeArticle"

WhatsApp Microservice & Cloud API

WhatsOmni supports a powerful Dual WhatsApp Architecture: instant QR-code device pairing via the native Baileys Microservice, or enterprise official high-volume messaging via the Meta WhatsApp Cloud API.

Mode A: Baileys Microservice (QR Code Pairing)

The Baileys worker is a Node.js microservice running on port 5001 that maintains persistent WebSocket connections with WhatsApp Web:

• Start the worker microservice:
  cd baileys-worker && npm start
• In your tenant dashboard, navigate to Channels → Connect WhatsApp.
• Select Scan QR Code, open WhatsApp on your phone (Linked Devices → Link a Device), and scan the live QR code generated in the dashboard.
• Session credentials are saved in baileys-worker/sessions/ and synchronized in real-time.

Mode B: Official Meta WhatsApp Business Cloud API

For high-throughput enterprise messaging with green badge verified numbers:

• Go to Meta for Developers → WhatsApp → API Setup.
• Copy your Phone Number ID, WhatsApp Business Account (WABA) ID, and generate a Permanent System User Access Token.
• Configure Webhooks under WhatsApp → Configuration:
  Callback URL: https://api.yourdomain.com/api/webhooks/channel/{connection_id} (where {connection_id} is the channel connection ID shown on your channel setup screen)
  Verify Token: Enter your configured webhook token matching the channel settings.
• Subscribe to the messages webhook topic.
• Enter the credentials into your tenant channel settings in WhatsOmni.

Baileys Worker Configuration Parameters

Dashboard & Workspace Navigation

The WhatsOmni Customer Dashboard provides an intuitive, high-performance command center designed for modern sales, support, and marketing teams to orchestrate customer journeys across all messaging channels from a single unified interface.

Workspace Switcher & Multi-Brand Management

If your subscription plan supports multiple workspaces, you can manage different brands, company subsidiaries, or client accounts under a single login. Click the Workspace Selector in the top-left corner of the sidebar to switch between workspaces instantly without logging out.

Team Member Roles & Permissions Matrix

Invite team members and assign granular permission roles to control data access and security across your organization:

Multi-Workspace Management

Manage multiple distinct brands, corporate subsidiaries, or agency client accounts from a single user login. Each workspace maintains strict data isolation, dedicated messaging channels, separate CRM deal boards, custom visual flows, and allocated plan quotas.

Managing Workspaces Workflow

Channel Management (9 Channels)

WhatsOmni unifies customer interactions and social publishing across 9 communication channels into one real-time workspace stream. Connect direct messaging lines, social profiles, email boxes, and SMS carriers effortlessly.

1. WhatsApp Cloud API

Official Meta Graph API, Embedded Signup, verified green badge, templates, catalogs, and read receipts.

2. WhatsApp Baileys (QR)

Instant phone QR scan pairing via Node.js microservice with multi-device support and auto-reconnect.

3. Instagram Direct & Posts

DMs, story replies, story mentions, and Social Posts carousel/reel publishing via Meta Graph API.

4. Facebook Messenger & Pages

Facebook Page inbox synchronization, quick reply buttons, post comment auto-replies, and feed publishing.

5. TikTok (DMs & Video Kit)

TikTok Login Kit for Web, 2-way customer DM synchronization, and automated 9:16 short video/reel publishing.

6. LinkedIn (Content Publishing)

OAuth2 publishing of carousels, text updates, and videos across Personal Profiles and Organization Company Pages.

7. Telegram Bot

Deploy responsive bots via BotFather HTTP tokens with rich markdown, inline keyboards, and command routers.

8. SMS (6 Gateways)

Global 2-way SMS routing via Twilio, Vonage, Plivo, MessageBird, Sinch, and Telnyx with delivery status tracking.

9. Two-Way Email Gateway

Inbound IMAP mailbox listener with HTML email parser and outbound SMTP/Resend mailer with conversation threading.

Channel Assignment & Shared Inbox Isolation

In enterprise organizations with multiple brands or specialized departments (e.g. Sales, Technical Support, Billing), administrators can assign specific channels to designated team members. Agents only see and interact with messages from their assigned channels, preventing clutter and ensuring privacy.

How to Configure Channel Assignments

Unified Team Inbox

The Unified Team Inbox consolidates customer messages across all 9 supported channels into a single shared inbox with real-time WebSocket updates, contact CRM drawer, and AI Copilot assistance.

Conversation Lifecycle & Status Management

Canned Responses, Dynamic Variables & Private Notes

• Slash Commands (/): Type / into the message composer to open your team's pre-approved library of canned responses. Use dynamic tags like {{contact.first_name}}, {{agent.name}}, or {{workspace.name}} to personalize answers instantly.
• Private Team Notes (Yellow Mode): Toggle to Private Note mode to post internal comments visible only to team members. Use @colleague mentions to collaborate on complex escalation cases without the customer seeing the thread.

Social Posts Studio & Content Scheduler

The Social Posts Studio (/social-posts) empowers marketing teams to compose, preview, AI-generate, and schedule high-performing content across Facebook Pages, Instagram Business, LinkedIn Profiles/Pages, and TikTok from a single interactive calendar command center.

Step-by-Step Publishing & Scheduling Workflow

Visual Drag-and-Drop Flow Builder

The Visual Flow Builder lets you design sophisticated multi-step conversational journeys, automated lead qualification sequences, appointment booking funnels, and CRM synchronizations on an intuitive drag-and-drop canvas without writing code.

Visual Lead Qualification Architecture

AI Agents & Knowledge Base (RAG)

WhatsOmni features an enterprise Retrieval-Augmented Generation (RAG) AI Engine. Upload your company's product manuals, return policies, pricing documents, and website URLs to train an autonomous AI Assistant that delivers grounded, hallucination-free support across all channels.

Supported Knowledge Ingestion Sources

Configuring an AI Assistant Persona

• System Prompt & Persona: Define agent identity, tone (e.g. professional, empathetic, concise), refund policy guidelines, and custom greetings.
• Creativity & Temperature: Set between 0.0 (strictly factual based solely on documents) and 0.7 (creative and conversational).
• Foundation Model Selection: Choose from OpenAI GPT-4o, Anthropic Claude 3.5 Sonnet, Google Gemini 2.0 Flash, DeepSeek R1, or Groq Llama 3.3.

Autonomous Human Agent Handoff

Configure smart safety triggers that seamlessly transfer conversations to human support agents:

Deals & CRM Pipelines

Track revenue opportunities, manage sales stages, and qualify prospects directly alongside your customer chats with the native WhatsOmni CRM Pipeline and bi-directional external CRM synchronization.

Automated Deal Progression via Chat Workflows

• Auto Deal Creation: When a prospect completes a lead qualification flow on WhatsApp, a deal is instantly created with budget estimates.
• Stage Advancement on Booking: When the client books a meeting slot on the calendar, the deal automatically advances to Demo Scheduled and assigns the staff host.
• Bi-Directional External Sync: Any update made in WhatsOmni synchronizes automatically with HubSpot, Salesforce, or Zoho CRM.

Calendar & Appointments

WhatsOmni eliminates scheduling friction by enabling clients to book consultations, product demos, and support appointments directly inside WhatsApp, conversational DMs, or public booking links with dynamic 2-way Google and Microsoft 365 calendar synchronization.

Automated WhatsApp Reminder Sequence

Cart Recovery Engine

Over 70% of online shopping carts are abandoned before checkout. The WhatsOmni Abandoned Cart Recovery Engine re-engages shoppers on WhatsApp with high-converting personalized sequences and one-click checkout URLs.

Connecting E-Commerce Stores (Shopify & WooCommerce)

• Shopify Store Webhooks: In your Shopify Admin, navigate to Settings → Notifications → Webhooks and create webhooks pointing to https://api.yourdomain.com/api/webhooks/ecommerce/shopify for Checkout creation, Checkout update, and Order creation with JSON formatting.
• WooCommerce REST Webhooks: In WordPress Admin, go to WooCommerce → Settings → Advanced → Webhooks and create webhooks pointing to https://api.yourdomain.com/api/webhooks/ecommerce/woocommerce?connection_id={id} for Order created and Order updated.
• WhatsOmni automatically ingests abandoned cart items, line-item totals, and customer contact data, triggering automated recovery sequences via SendAbandonedCartRecoveryJob on Redis queues.

Broadcast Campaigns & Anti-Ban Architecture

Execute enterprise-grade mass outreach campaigns across WhatsApp (Baileys QR & Meta Cloud API), Telegram, SMS, and Email. WhatsOmni features an intelligent anti-ban rate-limiting engine with randomized jitter, a two-tier non-blocking asynchronous Redis queue pipeline, in-flight pause/resume controls, and zero-duplicate crash resumption.

Baileys vs Meta WhatsApp Cloud API Campaign Comparison

Campaign Launch Workflow

Custom Roles & 19-Module Granular RBAC

Enforce zero-trust operational security across your organization. WhatsOmni’s Custom Role Builder (located at /settings/team under the Roles tab) allows workspace owners to create custom staff roles with granular Read and Write permission scopes across all 19 functional workspace modules grouped into 5 core platform categories.

The Complete 19-Module Permission Matrix

Custom Role Creation Workflow

Dashboard & Platform Telemetry

The Super Admin Dashboard (located at /superadmin/dashboard) provides platform operators with real-time operational telemetry, aggregate revenue metrics, workspace growth rates, channel adoption statistics, and live security audit logs.

Dedicated Analytics & Reports Console

Navigate to Analytics & Reports (/superadmin/analytics) for in-depth platform performance analysis:

Tenants & Global Users

The Tenants and Users modules give Super Admins complete operational oversight over all registered business workspaces, workspace team members, and user credentials across the platform.

One-Click Ghost Impersonation Architecture

Plans & Subscriptions

The Plans module (/superadmin/plans) enables platform operators to build, price, and manage multi-currency subscription tiers, feature limit matrices, and automated billing integrations across Stripe, PayPal, Razorpay, Paystack, and Flutterwave.

Multi-Currency Global Pricing Engine

WhatsOmni allows Super Admins to define explicit localized prices per currency or let the dynamic GeoIP engine convert automatically from the base platform currency:

Plan Quotas & Limits Schema

Multi-Currency & GeoIP Engine

The Currencies module (/superadmin/currencies) and GeoIP Localization Engine provide automated currency rate synchronization, visitor country-to-currency auto-detection, and intelligent gateway payment routing across 150+ countries.

Payment Gateway Currency Routing Compatibility Matrix

Payment Gateway	Primary Currencies Supported	Recurring Billing Mechanism	Webhook Status
Stripe	USD, EUR, GBP, CAD, AUD, SGD, JPY	Stripe Billing (Cards / SEPA)	Auto-Handled
PayPal Subscriptions	USD, EUR, GBP, AUD, CAD, BRL	PayPal Billing Agreements / Vault	Auto-Handled
Razorpay	INR (Primary), USD, AED, EUR	Cards, UPI AutoPay, NetBanking	Auto-Handled
Paystack	NGN, GHS, ZAR, KES, USD	Tokenized Card Subscriptions & Bank Debit	Auto-Handled
Flutterwave	NGN, KES, GHS, UGX, TZS, ZAR, USD	Cards, M-Pesa Mobile Money, Bank Account	Auto-Handled

GeoIP Detection & Price Conversion Pipeline

Channels & Integrations Switchboard

The Channels and Integrations control centers enable Super Admins to globally enable or disable messaging gateways, configure master SMS carrier credentials, and verify external service connectivity across all 9 platform channels.

Integrations Health & Environment Diagnostics

AI Providers & Intelligent Routing

The AI Providers module (/superadmin/ai-providers) is the central orchestration engine for AI models across WhatsOmni. Super Admins can manage foundation model credentials, switch between the 2 operational architectures (BYOK and Master Fixed), and map individual platform features to specific LLMs.

Feature Routing Matrix (Master Fixed Mode)

Settings, Gateways & White-Labeling

The Settings (/superadmin/settings), Payment Gateways (/superadmin/settings/gateways), Support Tickets (/superadmin/tickets), and Pages (/superadmin/pages) modules provide full white-label customization, team delegation, transactional mail management, 5 global payment gateway configurations, and tenant support operations.

Global Gateways

5 Payment Gateways

Configure Stripe, PayPal, Razorpay, Paystack, and Flutterwave with live/test key toggles & webhook secrets.

White-Labeling

Custom Branding

Brand name, primary/accent color swatches, custom domain, and SVG logo upload synced across all tenant sessions.

Email Engine

Dynamic Mail Engine

Switch between Resend API and SMTP without server restarts. Includes live in-app test sender & visual mail designer.

Support & CMS

Support Tickets & CMS

Threaded ticket console to resolve tenant inquiries and manage public legal pages (Terms, Privacy, About).

Global Payment Gateways Configuration Workflow