KeyHelp

KeyHelp

Developed By Ricardoneud.com

Compatible with WHMCS v8.13

A WHMCS module for seamless integration with KeyHelp control panel. This module allows you to automate hosting account provisioning, management, and billing for KeyHelp-based services directly from WHMCS.

Features

Account Management

  • Create Accounts: Automatically create hosting accounts in KeyHelp when a product is ordered in WHMCS.
  • Suspend/Unsuspend Accounts: Suspend or unsuspend accounts directly from WHMCS.
  • Terminate Accounts: Remove accounts from KeyMHelp when terminated in WHMCS.
  • Change Password: Update client passwords in KeyHelp from WHMCS.
  • Change Package: Upgrade/downgrade hosting plans in KeyHelp.

Single Sign-On (SSO)

  • Client SSO: Allow clients to log in to their KeyHelp panel directly from the WHMCS client area.
  • Admin SSO: Admins can log in to the KeyHelp admin panel from WHMCS.

Automation & Sync

  • Daily Sync: Automatically sync usage statistics (disk, bandwidth, domains, etc.) from KeyHelp to WHMCS.
  • Usage Updates: Update resource usage in WHMCS based on real-time KeyHelp data.
  • Client Data Sync: Sync client contact details between WHMCS and KeyHelp.

Client Area Features

  • Resource Overview: Display disk usage, bandwidth, domains, email accounts, databases, and FTP users.
  • Domain Management: View domains (including SSL status and domain status) in the client area.
  • Email Management: List email accounts, usage, and aliases.
  • Database Management: View database names, usernames, and sizes.
  • FTP Management: List FTP users and their home directories.

Admin Features

  • List Accounts: View all KeyHelp accounts in the WHMCS admin area.
  • Custom Buttons: Add custom buttons for quick actions (e.g., "Sync Account").
  • Admin Services Tab: Display KeyHelp account status, creation date, and resource usage.

Hooks

  • Client Edit Hook: Sync client details in KeyHelp when edited in WHMCS.
  • After Module Create Hook: Sync resource usage after account creation.
  • Welcome Email Hook: Send welcome emails with login credentials.
  • Password Change Hook: Log password changes.
  • Termination Hook: Log account terminations.

Customization

  • Username Generation: Customize how usernames are generated.
  • Hosting Plan Loader: Dynamically load hosting plans from KeyHelp.
  • Override Functions: Extend or override default behavior with custom functions.

Requirements

  • KeyHelp: API v2 access
  • cURL: Enabled
  • WHMCS: 8.11 or later
  • PHP: 8.3 or later

Installation

  1. Upload Files: Upload the module files to /modules/servers/keyhelp/ in your WHMCS installation.
  2. Configure Server:
    • Go to Setup > Products/Services > Servers in WHMCS.
    • Add a new server with type KeyHelp.
    • Enter your KeyHelp server details (hostname, API key, port, etc.).
  3. Configure Products:
    • Create a product in WHMCS and assign it to the KeyHelp server.
    • Set the module name to keyhelp.
    • Configure the product options (hosting plan, language, etc.).
  4. Enable Hooks: Ensure all hooks are enabled in WHMCS.

Configuration

Module Settings

  • Hosting Plan: Select the KeyHelp hosting plan.
  • Default Language: Set the default language for the KeyHelp panel.
  • Create System Domain: Automatically create a system domain.
  • Send Login Credentials: Email login credentials to the client.

Custom Functions

  • Override username generation, client data, or domain data by uncommenting and modifying the provided functions in the module.

 

Share via Facebook Share via Twitter Share via LinkedIn

There are no reviews yet!

Be the first to review KeyHelp.

Version Compatibility


Compatible with WHMCS v8.13

Full Version Compatibility


  • All versions of WHMCS v8.13
  • All versions of WHMCS v8.12
  • All versions of WHMCS v8.11

System Requirements


  • KeyHelp API v2 access
  • cURL Enabled
  • WHMCS 8.11 or later
  • PHP 8.3 or later

* Requirements listed are in addition to the WHMCS default system requirements.

Support for this product

The best place to start if you need help with a specific product is to contact the developer. All WHMCS Marketplace developers have both a website and support URL listed.

Visit Website Contact Support

Developed By Ricardoneud.com

Changelog

v1.1 Released December 6th, 2025

Latest Version


Added

  • Randomized Username Generation: New secure username generation system
    • Generates random usernames in format: [letter][2-digits][letter][letter] (e.g., a42bc)
    • Prevents conflicts with other accounts from the same WHMCS client
    • Ensures unique usernames across suspend, unsuspend, and terminate operations
    • Still fully customizable via override function in config.php
  • Configuration Files: Added comprehensive configuration system
    • config.sample.php: Complete reference with all available override functions and extensive documentation
    • config.php: Ready-to-use configuration file with essential functions for standard functionality
    • Easy customization for advanced use cases

Fixed

  • Account Sync Issues: Resolved problems with syncing individual accounts
    • Fixed date format incompatibility causing Carbon exceptions
    • Proper handling of ISO-8601 datetime format from KeyHelp API
    • Improved error logging for troubleshooting sync operations
  • Client ID Transmission: Fixed client ID not being sent to KeyHelp
    • Client ID is now properly included in contact_data during account creation
    • Ensures proper tracking and association between WHMCS and KeyHelp accounts
  • Username Conflicts: Eliminated issues with duplicate or conflicting usernames
    • Previous implementation could cause conflicts during account lifecycle operations
    • New random generation ensures uniqueness across all operations

Changed

  • Username Generation Logic: Complete overhaul of username creation system
    • Moved from predictable patterns to secure random generation
    • Improved collision detection and retry mechanism
    • Maintains backward compatibility with custom override functions
  • SSO User Interface: Relocated SSO login button
    • Moved from page content to sidebar for better accessibility
    • Maintains consistent user experience across different client area pages

Technical Details

  • Enhanced keyhelp_ListAccounts() function with proper date handling
  • Added DateTime conversion for created_at field compatibility
  • Updated metadata configuration for Server Sync Tool integration

Migration Notes

  • Existing installations will continue to work without changes
  • To use random username generation, simply update the addon
  • Custom username generation can still be implemented via config.php
  • Review config.sample.php for all available customization options

 

Previous Versions


v1.0 Released December 3rd, 2025

View/hide detailed changelog

Added

  • Initial Release: First stable version of the WHMCS KeyHelp module.
  • Account Management: Create, suspend, unsuspend, terminate, and change passwords/packages.
  • Single Sign-On (SSO): Client and admin SSO for KeyHelp panel.
  • Automation: Daily sync for resource usage and client data.
  • Client Area: Resource overview, domain/email/database/FTP management.
  • Admin Features: List accounts, custom buttons, and services tab.
  • Hooks: Client edit, after module create, welcome email, password change, and termination hooks.
  • Customization: Override username generation, client/domain data, and validation.
  • Documentation: README and changelog for setup and usage.

 

See also

Liquid Web VPS & Cloud Dedicated Reseller Program

Resell VPS & Cloud Dedicated Products from Liquid Web

Free
Kopage Website Builder for Webhosts with support for WHMCS, cPanel, DirectAdmin & more

Kopage, self-hosted, Website Builder for Webhosting Companies your clients will love to use. Attract more clients and reduce churn rate with easy and intiutive website builder.

Free
PaaS Extension for WHMCS

Turnkey PaaS, Docker hosting, auto-scalable clusters and VPS with full integration to WHMCS

Free
Dedicated Server Reseller for WHMCS

Resell Dedicated Servers from Limestone Networks white label API.

Free
Free Site.pro Website Builder

White Label Website Builder

Free