WHMCS Module

On this page

Overview
Requirements
Download
Upload
Activation
Configuration
How it works
Error handling
Troubleshooting
FAQ

Overview

The WHMCS addon sends WhatsApp notifications for invoices, payments, service and order events and tickets, adds a WhatsApp Number field at signup, and keeps full delivery logs — all inside WHMCS.

Requirements

WHMCS 8.x (works on 7.10+)
PHP 7.4–8.3 (a universal build is included)
An API key and active plan

Download

Get bookbeywa from Client area → Downloads → WHMCS Module.

Upload

Copy the bookbeywa folder into your WHMCS install at:

<whmcs>/modules/addons/bookbeywa/

Upload by FTP/SFTP or your host's file manager. Keep the folder name exactly bookbeywa.

Activation

In WHMCS admin: Setup → Addon Modules (or System Settings → Addon Modules on 8.x) → find BOOKBEY WhatsApp Notifications → Activate → then Configure to set access control for admin roles.

Configuration

Open the module and set:

API Base URL = https://bookbey.com/public/api
API Key = your vccl_live_… key
Templates — edit the message text for each event (invoice created, payment received, order, ticket, etc.)

Use Send test to fire a message to your own number and confirm the key + number work end to end.

How it works

Once active, the module hooks WHMCS events and messages the client's WhatsApp number automatically. Every attempt is written to the module's log with the API message id and result, so you can audit deliverability.

Error handling

Errors are returned as JSON with ok:false, a machine-readable error code and a human message. The HTTP status reflects the error class.

HTTP	error code	Meaning & fix
401	`unauthorized` / `invalid_api_key`	Key missing, wrong, or revoked. Re-copy it from API Keys.
402	`no_active_plan`	No active plan on the account. Buy or renew a plan.
403	`account_suspended`	Account suspended. Contact support / clear dues.
422	`invalid_json`	Body was not valid JSON. Check Content-Type and payload.
422	`invalid_number`	Destination number malformed. Use country code + number, digits only.
429	`quota_exceeded` / `rate_limited`	Monthly quota used up, or sending too fast. Check `status.php`; retry with backoff.
500	`server_error`	Transient server error. Retry; if it persists, contact support.

Troubleshooting

Module not listed: the folder must be modules/addons/bookbeywa/ and readable by the web user; re-check the path and permissions (folders 755, files 644).
Test send fails with invalid_api_key: re-copy the key and confirm the API Base URL has no trailing slash mismatch.
No message on real events: confirm the client has a valid WhatsApp Number saved and the relevant template is enabled.
PHP fatal after upload: use the universal (7.4–8.3) build that matches your server's PHP.

FAQ

Does it change WHMCS core? No — it's a standard addon. Can staff send manually? Yes, from the module's send screen. Are logs kept? Yes, with per-message status.

Need help? Open a ticket from Client area → Support. Your API base URL is https://bookbey.com/public/api.