Installing the Cron Job
The cron job should be installed in the same manner as your normal WHMCS cron job.
The cron job should be configured to run every 5 minutes or sooner.
The cron job syntax should follow:
*/5 * * * * php /path-to-whmcs/modules/addons/monarx/cron.php
Ensure you use the same PHP binary and configuration as your WHMCS cron job. This will ensure it runs in exactly the same fashion. The only difference is the script to be invoked.
Available Tasks
Task | Command | Frequency |
Lead Synchronisation | leads:synchronize | Hourly |
Send Campaign Emails | leads:run-campaign | Daily |
Running Individual Tasks
It is possible to run individual tasks by appending the command. For example, to run the Leads Synchronisation task, you would run the following in your shell:
php /path-to-whmcs/modules/addons/monarx/cron.php leads:synchronize
Verbose Logging
By appending -vvv to your cron task or individually run command, you can enable verbose output which will output each individual task being run. This can be useful when requesting support for a command.