WHMCS Module

The MRRlytics WHMCS module is an optional addon that enhances your analytics by sending real-time events from WHMCS to MRRlytics. While the API-based sync handles the core data import, the module provides: - Real-time event notifications (new orders, cancellations, upgrades) - Faster data updates without waiting for the next sync cycle - Custom hooks for advanced integrations

1. Download the module from your MRRlytics dashboard (Settings > Instances > Download Module) 2. Extract the archive to your WHMCS installation: - Copy the "mrrlytics" folder to /modules/addons/ 3. In WHMCS admin, go to Setup > Addon Modules 4. Find "MRRlytics" and click "Activate" 5. Configure the module: - API URL: https://api.mrrlytics.com - API Key: Your MRRlytics API key (found in Settings > API Keys) 6. Click "Save Changes"

After activating the module, you can configure which events are sent to MRRlytics: - New client registration - Service/product orders - Service cancellations - Invoice creation and payment - Domain registrations and transfers - Upgrade/downgrade actions All events are enabled by default. You can disable specific events from the module configuration page.

The WHMCS module authenticates using an API key: 1. In MRRlytics, go to Settings > API Keys 2. Click "Generate New Key" 3. Copy the key (it will only be shown once) 4. Paste it in the WHMCS module configuration Keep your API key secret. If compromised, revoke it and generate a new one from the MRRlytics dashboard.

To verify the module is working correctly: 1. In WHMCS, go to Addons > MRRlytics 2. Click "Test Connection" 3. You should see a success message confirming the connection You can also check the module logs at Utilities > Logs > Module Log in WHMCS.

To update the module: 1. Download the latest version from your MRRlytics dashboard 2. Replace the files in /modules/addons/mrrlytics/ 3. In WHMCS, go to Setup > Addon Modules > MRRlytics 4. Click "Save" to apply any database updates Updates are backward compatible and your configuration will be preserved.

To remove the module: 1. In WHMCS admin, go to Setup > Addon Modules 2. Find "MRRlytics" and click "Deactivate" 3. Delete the /modules/addons/mrrlytics/ folder Uninstalling the module does not affect your MRRlytics account or data. The API-based sync will continue to work normally.