Skip to content

Knowledgebase

Collect a safe WHMCS module log for troubleshooting

whmcs, resellers

WHMCS module logging helps diagnose communication between the billing application and a server, registrar or payment integration. Enable it for a controlled reproduction and retain only the evidence needed to understand the failure.

01 Capture a useful diagnostic

  1. Record the affected client or service, action, time, WHMCS version and module version.
  2. Open System Logs and Module Log using an administrator role with the required debug-log permission.
  3. Set Module Logging to On.
  4. Reproduce the specific issue once, after checking whether a previous remote operation already completed.
  5. Refresh the log and identify the matching request and response.
  6. Turn Module Logging Off when the reproduction is complete.
  7. Prepare a redacted extract for the appropriate support team, preserving the error code and sequence.

02 Choose the right log

Use Gateway Log for payment returns, Ticket Mail Import Log for incoming support mail and Activity Log for general application events. The web server or PHP environment log can contain failures that occur before WHMCS completes its own logging setup.

A module error may originate from the remote provider or the module's interpretation of its response. Include the actual remote state when escalating, especially for creation, renewal or cancellation requests that can succeed before a timeout.

Common questions

Why is the module log empty?

It records module activity only while enabled and only for integrations that log through the relevant mechanism. Confirm the action actually ran and check the appropriate alternative log.

Should logging remain enabled permanently?

Use focused diagnostic periods. Logs can accumulate sensitive data and consume storage; apply the approved retention process after resolving the issue.

Is it safe to post the complete request publicly?

No. Review it for API keys, passwords, personal information and internal addresses. Share a redacted extract through the support channel appropriate to the data.

Avoid enabling public error display merely to collect a private module response.

Was this answer helpful?

Need a little more help?

Our support team can help you find the next step.

Contact support

Powered by WHMCompleteSolution