Microsoft Clarity WHMCS Module

Overview

The Microsoft Clarity WHMCS Module integrates Microsoft Clarity for tracking and analytics on your WHMCS client area.

Features

• Easy integration with Microsoft Clarity
• Add your Microsoft Clarity Project ID in the admin area
• Automatically injects the Clarity tracking code into client area pages

Installation

1. Upload the Module

• Upload the entire clarity folder to your WHMCS installation under modules/addons/.

2. Activate the Module

• Log in to your WHMCS admin area.
• Go to Setup > Addon Modules.
• Find the "Microsoft Clarity" module and click Activate.

3. Configure the Module

• After activation, click Configure.
• Enter your Microsoft Clarity Project ID in the provided field.
• Click Save Changes.

File Structure

modules/
└── addons/
    └── clarity/
        ├── clarity.php
        ├── hooks.php
        ├── install.php
        ├── lang/
        │   └── english.php
        └── templates/
            └── config.tpl
README.md

Module Files

• clarity.php: Main module configuration file.
• hooks.php: Contains the hook for injecting Clarity tracking code.
• install.php: Handles the installation and uninstallation logic.
• lang/english.php: Language file for English.
• templates/config.tpl: Admin configuration template.

Hooks

• ClientAreaHeadOutput: This hook injects the Clarity tracking code into the head of client area pages.

Configuration

• Clarity Project ID: Your Microsoft Clarity Project ID, which can be obtained from the Microsoft Clarity dashboard.

Uninstallation

1. Deactivate the Module

• Log in to your WHMCS admin area.
• Go to Setup > Addon Modules.
• Find the "Microsoft Clarity" module and click Deactivate.

2. Remove the Files

• Delete the clarity folder from modules/addons/.

Getting Your Microsoft Clarity Project ID

1. Sign Up for Microsoft Clarity

• Go to the Microsoft Clarity website.
• Click on the "Get started" button.
• Sign in with your Microsoft account or create a new one.

2. Create a New Project

• After signing in, click on "New Project".
• Fill in the required information such as the name of your project and the URL of the website you want to track.
• Click "Create".

3. Retrieve Your Project ID

• Once the project is created, go to the project settings.
• Your Clarity Project ID will be displayed in the project details section.

Support

If you encounter any issues or need further assistance, please contact [email protected].

Author

This module is developed and maintained by Juber Shaikh. Feel free to contribute or report any issues on Notchweb.