Automation is a key part of WHMCS and one of the ways in which we help businesses succeed. However, API calls and automation can sometimes fail and this is where the Module Queue comes in.
The Module Queue keeps track of any automated actions with 3rd party systems that fail related to services, add-ons and domain names, including actions such as:
- Hosting Account Creation
- Service Provisioning via Modules
- Account Suspensions/Reactivations
- Domain Registrations/Transfers/Renewals
- Delinquent Account Terminations
It's one of the features that's often overlooked, but is immensely helpful in understanding and keeping track of when things have gone wrong and getting them resolved as quickly as possible.
How It Works
Whenever an automated action such as one of those listed above fails, it gets added to the Module Queue and you'll receive an email notification to let you know that something went wrong.
You can think of the Module Queue as a list of actions waiting to be performed. It gives you a quick and easy way to review any automated actions that have failed, and retry them in just a matter of clicks. You can access it via the admin dashboard, daily cron notification email or Utilities menu (it's the 3rd option down).
Pictured below is my Module Queue with 3 actions pending resolution, 2 related to cPanel provisioning calls, and one domain registration failure attempt.
You can retry queue items one item at a time, or trigger a retry of all pending queue items. In the above image, the first item in the queue is currently being submitted for retry. For each item that is selected for retry, WHMCS will attempt to communicate with the 3rd party system and perform the requested action again. The result will be displayed on screen and if the action is successful, the item gets marked as resolved and is removed from the list.
You also have the option to mark a pending queue item as Resolved manually - useful for times when the action has been performed manually outside of WHMCS and therefore you don't need WHMCS to attempt it any more.
To help ensure you never miss a notification, and ensure you get a chance to resolve issues as quickly as possible, you get alerted to pending Module Queue items on the admin dashboard via the badges widgets:
If there are pending Module Queue items, you'll also see this banner in the daily automation cron report that gets sent to you by email each day:
The Module Queue provides a fast and efficient way to stay on top of and keep in control of failed automation actions. Resolve issues before your customers ever realise there's a problem by keeping a close eye on the Module Queue.
If you have any questions about the Module Queue or any feedback or suggestions for ways it can be improved, we invite you to leave your comments below.
Thanks for reading!
Liked this article? Share it