Knowledgebase

Everything you need to integrate BOOKBEY WhatsApp. The API basics are below; full install, configuration and troubleshooting guides for every SDK and module are in the sidebar. Your API base URL is https://bookbey.com/public/api — get an API key from your client area.

Getting started

1) Sign up and choose a plan. 2) Connect your WhatsApp number. 3) Generate an API key. 4) Pick your integration from the sidebar — an SDK, the WHMCS, WooCommerce or Magento module, or the raw REST API — and start sending.

Authentication

Send your key as a Bearer token, or as an X-API-Key header. Both are accepted; keys are isolated per client and stored only as hashes.

Authorization: Bearer YOUR_API_KEY
# or
X-API-Key: YOUR_API_KEY

Send a message

PUT https://bookbey.com/public/api/send.php with a JSON body.

curl -X PUT https://bookbey.com/public/api/send.php \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"9198XXXXXXXX","type":"text","text":"Hello from BOOKBEY!"}'

Supported type values: text, image, document (by URL or base64), and Cloud API template. Full payload shapes are in the REST API guide.

Status & quota

curl https://bookbey.com/public/api/status.php -H "X-API-Key: YOUR_API_KEY"
=> {"ok":true,"plan":"Basic","limit":2000,"used":3,"remaining":1997}

Website chatbot

After purchasing the one-time chatbot, open Web Chatbot in your client area, set your Q&A and appearance, then paste the embed snippet before </body>:

<script src="https://bookbey.com/public/chatbot/embed.js?k=YOUR_PUBLIC_KEY" async></script>

The widget answers from your Q&A, captures leads into your dashboard, and offers a WhatsApp handoff to your connected number.

Error codes

Responses are JSON with ok:false and an error code, e.g. invalid_api_key, account_suspended, no_active_plan, quota_exceeded, rate_limited. HTTP status reflects the error class. Each module guide lists the full table.