Zendesk For WHMCS

About Zendesk For WHMCS

Zendesk For WHMCS replaces the standard WHMCS support system with the complex choice of Zendesk tools. The module will enrich your client area with various extra features, allowing customers to fill in Zendesk ticket fields and use emojis. At the same time, you and your staff members will be free to monitor and manage every ticket created in WHMCS straight from within the Zendesk admin area.

• Client Area Features:

✔ View Zendesk Departments

✔ Open New Ticket In Chosen Department

✔ Open New Ticket From "Contact Us" Form

✔ Manage Existing Tickets

✔ Fill In Zendesk Ticket Fields

✔ Select Related Service

✔ Attach Files To Ticket

✔ List Recent Tickets

• Admin Area Features:

✔ Configure And Test Server Connection

✔ OAuth Authorization

✔ API Token Authorization

✔ Toggle SSL Connection

✔ Toggle SSO For Only Verified Users

✔ Select Zendesk Brand

✔ Choose Available Support Departments

✔ Choose Available Ticket Fields

✔ Choose Default Department For Exported Tickets

✔ Choose Department For "Contact Us" Tickets Opened By Visitors

✔ Define Client Service Field

✔ Manually Export To Zendesk:

✔ WHMCS Users

✔ WHMCS Tickets

✔ Check Status Of Exported Users

✔ Define Module Behavior:

✔ Show Solved Tickets

✔ Define Order Of Replies

✔ Allow Shared Login Redirection

✔ Update Client Credentials

✔ Define Default Column And Sorting Direction For Tickets

✔ Define Ticket Status Colors

✔ View Logs

• Integration Features:

✔ Single Sign On (SSO) Integration

✔ Automatically Export To Zendesk:

✔ New Tickets

✔ Users On Tickets Creation

✔ Synchronize Ticket Responses Between WHMCS And Zendesk

✔ Transfer Ticket Fields Settings

✔ Transfer Attachments Settings

✔ Convert Markdowns To HTML And Emojis

✔ Use Multibrand For WHMCS Integration To:

✔ Export Branded Tickets To Selected Departments

✔ Define Per Brand:

✔ Default Department

✔ Contact Us Department

✔ Available Departments

✔ Available Ticket Fields

• General Info:

✔ Integrated With Multibrand For WHMCS - Export And Create Tickets From Each Brand To Chosen Departments

✔ Supports Zendesk Multibrand Feature

✔ Supports Zendesk Emoji - Artworks Provided By JoyPixels

✔ Custom Templates Support

✔ Fully Integrated With Lagom WHMCS Client Theme

✔ Multi-Language Support

✔ Supports PHP 8.3 Back To PHP 8.2

✔ Supports WHMCS Themes "Six", "Twenty-One" And "Nexus"

✔ Supports WHMCS V9.X Back To WHMCS V8.10

✔ Requires ionCube Loader V14 Or Later

✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

This tutorial will show you how to successfully install and configure Zendesk For WHMCS. We will guide you step by step through the whole installation and configuration process.

Installation

1. Log in to our client area and download Zendesk For WHMCS.

2. Extract the package and upload its content into the main WHMCS directory. The content of the package to upload should look like this.

3. When you install Zendesk For WHMCS for the first time you have to rename 'license_RENAME.php' file. The file is located in 'modules/addons/Zendesk/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

4. In order to configure your license key, you have to edit the previously renamed 'license.php' file. Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

5. Now, set up the 'storage' folder as recursively writable. This folder is available at 'your_whmcs/modules/addons/Zendesk/'.

Activation

6. Now, you have to activate the module in your WHMCS system. Log in to your WHMCS admin area and proceed to 'Setup' → 'Addon Modules'. Afterward, find 'Zendesk' and press the 'Activate' button.

7. In the next step, you need to permit access to this module. To do so, click on the 'Configure' button, tick checkboxes to assign desired admin roles.

8. You have just successfully installed Zendesk For WHMCS!

Server Configuration

In the Server Settings section, you must configure the connection between your WHMCS system and your Zendesk account. Select the authentication method used to authorize communication with the Zendesk API: API Token – recommended for quick setup using a Zendesk API token. OAuth – a more secure authentication method based on Zendesk OAuth authorization.

API Token Authorization

Select API Token as the authentication method to connect using Zendesk API credentials. Fill in the following fields: Account Name - Enter your Zendesk subdomain used to access the Zendesk panel, for example: yourcompany. If your Zendesk URL is: https://yourcompany.zendesk.com then the Account Name should be yourcompany. Administrator Email - Provide the email address of the Zendesk administrator account used to access the API. API Token - Enter the API token generated in your Zendesk Admin Center. Additional Settings: Shared Secret Token - the token used for Zendesk Single Sign-On (SSO). SSL Connection - enable this option to establish a secure connection with the Zendesk API. Login for Verified Users Only - allows the Single Sign-On action only for verified users. After saving the configuration, you can verify the connection using the Test Connection button.

Generate Zendesk API Token

Firstly, log in to your Zendesk Admin Center in order to enable API access.

Go to 'Admin Center' → 'Apps and integrations' → 'APIs' → 'Zendesk API'. There, in the 'Settings' section find 'Token access' and enable it. Add a new token or use an existing one if you already created it. Important: Make sure to copy and store this token. It won't be shown again after you click 'Save' or leave this page. You will also need it in a moment to complete the configuration of the module.

Now go to 'Account' → 'Security' → 'End users authentication' section where you can enable 'External authentication'. The action is optional. Once this option is enabled, press the 'Edit' button as shown below. Note: Thanks to this feature, when clients go to the ticket URL that leads directly to the Zendesk panel (e.g. from the Zendesk email notification), they will be redirected first to your WHMCS, and after logging in, they will be again redirected and automatically logged into the Zendesk panel to view the ticket.

Once clicked, you will be redirected to the 'Single-Sign On' section where you will be able to add your remote login URL and remote logout URL. They should lead to 'loginshare_jsonwt.php' file located in 'yourWHMCS/modules/support/Zendesk/' directory. For example: https://yourWHMCS.com/modules/support/Zendesk/loginshare_jsonwt.php

Next, scroll down to the bottom of the page and find 'Shared Secret' section. Copy and keep your 'Shared Secret' in a safe place. It will be needed later. Do not forget to press the 'Save' button, you will find it at the bottom of the page. Note: The 'Shared Secret' is not required for Zendesk module to work itself. It is needed for SSO only.

OAuth Authorization

Select OAuth if you want to authorize the integration using Zendesk OAuth authentication. OAuth provides a secure authentication flow where credentials are not stored directly in the module. Required Fields: Client ID - Enter the Client ID (Identifier) generated in the Zendesk Admin Center for your OAuth application. Client Secret - Enter the Client Secret assigned to your OAuth application in Zendesk. See the section below to learn where to find the required data in Zendesk.

Configuring OAuth in Zendesk

Before using OAuth, you must create an OAuth client in Zendesk: 1. Log in to your Zendesk Admin Center. 2. Navigate to Apps and Integrations → APIs → OAuth Clients. 3. Click Add OAuth Client. Note: If you already have an OAuth client created in Zendesk, you may reuse it instead of creating a new one.

4. Provide the required application details. 4.1. In the Client kind dropdown, select Confidential (required). 4.2. In the Redirect URL field, enter the redirect address displayed in the module configuration panel. 5. Save the client and copy the Client Secret. The client secret appears immediately after clicking the Save button and will not be accessible once you leave this page. Important: The Redirect URL configured in Zendesk must match the address displayed in the module configuration panel. If the redirect URL is not set correctly, the OAuth authorization process will fail.

Authorization Process After entering the Client ID (Identifier) and Client Secret and saving the configuration: The module will redirect you to the Zendesk login page. Log in and authorize access for the application. After successful authorization, you will be redirected back to the module configuration page. The access token will be automatically stored by the module. The OAuth token remains valid for 30 days and is automatically refreshed by the module through the DailyCronJob to maintain uninterrupted connectivity. You can verify the configuration at any time using the Test Connection button.

WHMCS Configuration

Next, move to 'Setup' → 'General Settings' → 'Support'. Choose 'Zendesk' support module from a dropdown menu and save changes afterward. Note: From now on, your clients will see Zendesk tickets and departments (not the ones of WHMCS).

Good job! Your WHMCS installation is now connected with the Zendesk support system.

Management

Once Zendesk For WHMCS is installed and the connection configured, you can either create or update your ticket departments and start using them. Each ticket department you create in Zendesk will be available to your customers in the WHMCS client area.

Settings

WHMCS

Before you start your actual work on support tickets with Zendesk For WHMCS, move again to 'Addons' → 'Zendesk' → 'Ticket Settings'. This section of the addon allows the easy and comfortable management of the form in which tickets are displayed in your client area, their visibility, sorting properties, etc.

In the first box 'Options', you can enable several basic settings that will be applied to the tickets view in the client area. Let's now discuss their functionality in detail: Default Department - choose the Zendesk department that will be selected by default for exported tickets Allowed Departments - select which of your Zendesk departments shall be available for your WHMCS clients Ticket Fields - choose which ticket fields from the Zendesk panel should be displayed in the client area. Ticket fields marked as required in the Zendesk panel are not visible here and will show up in the client area automatically. Show Solved Tickets - if you enable this option, all tickets, no matter what status they have, will be displayed on the list of the latest tickets (e.g. open/new/solved/closed tickets, etc.); Replies Descending Order - enable this option to make ticket replies sorted by date in descending order when viewing a ticket Shared Login Redirection - if enabled, the user is redirected to the Zendesk panel after successfully shared login (please refer to point 8 here for more information) Contact Us Integration - if enabled, tickets from visitors will be sent to Zendesk Contact Us Department - select a default department for tickets sent from visitors via the "Contact Us" page. In case the "Contact Us Integration" option is disabled, a WHMCS department, selected at WHMCS → Setup → Mail → Presales Form Destination/Presales Contact Form Email, will be applied to such tickets. Zendesk Brand - if you have Zendesk Multibrand feature enabled on your account you can choose a brand here Template Name - Change only if you want to use a custom template. Custom template files should be placed in the '/modules/addons/Zendesk/templates/client/default/pages/submodule/yourCustomTemplateName' directory Client Services - choose the field (created in Zendesk) responsible for displaying all customer products and domains (click here for more information) Update Client Credentials - if enabled, each time the ID of a client's email, name or phone number is updated in WHMCS, it is updated in Zendesk accordingly. Default Sort Column - the tickets table in the client area will be by default sorted by the selected column. (Department/Subject/Status/Updated At) Default Sort Direction - pick the default sorting direction. (Ascending/Descending)

Below the 'Options' box you will find a box where you can assign colors to a specific ticket status. Click on the field to choose a color from the palette or type in the code of the color you like. Remember to save the changes if you modify the ticket settings in any way.

If you use Multibrand For WHMCS, you can also define various settings for separate brands. Simply, choose the preferred brand from the dropdown menu and complete the following fields. Do not forget to save changes.

Tickets will be now marked with selected colors on the homepage according to the status they have.

The color settings will be also viewable on your main tickets list.

Ticket Fields

You can also manage ticket fields that are available in WHMCS on a new ticket form, directly in Zendesk. Move to 'Zendesk' → 'Admin' → 'Manage' → 'Ticket Fields'. On this site, you can activate, deactivate, or edit any system and custom fields or add new ones. For test purposes, we activated and adjusted the 'Priority' field according to our needs.

As you can see on the screen below, a new field appeared in the WHMCS client area. Edit or add ticket fields to adjust the ticket form to fit your needs perfectly.

Service Field

The 'Client Service' field allows your customers to specify the service they refer to when creating a ticket. This can help your support teams more easily identify the problem with the service used by the client. Move to 'Zendesk' → 'Admin' → 'Manage' → 'Ticket Fields'. and press 'add field'.

There are a few types of fields to choose from. Click on the Text type to add your new ticket field.

We will now adjust the 'Client Service' field according to our needs. Firstly, you can complete an optional description. Then, select 'Editable for end users' permissions and make sure to leave the 'Required' box unchecked to keep this field optional for the clients when they open a new ticket.

Once you have created your new field, you can select it as 'Client Service' in the 'Ticket Settings' section of Zendesk. Do not forget to save settings.

As you can see on the screen below, a new field, which may help to draw the agent's attention to a specific client's service appeared in the WHMCS client area.

Next, when the agent accesses the ticket in the Zendesk panel, there will be information about the service selected by the client.

Export

Our module allows you to export data gathered in WHMCS, more specifically, all the users and tickets generated before the installation of the product. Read the below points to learn what data can be synchronized with Zendesk and what are the possible means of such synchronization.

Users

The first option offered by our module is the export of users from WHMCS to Zendesk, proceed to 'Users Export' . If you are using Zendesk For WHMCS for the first time, you will see here a list of all users who exist in your WHMCS and have not been synchronized with Zendesk yet.

Now, you can manually export all of the users available on the list or choose only some of them. Check boxes next to the users you are going to export and press the 'Export' button, marked with the red arrow on the screen. You can always check the status of the exported clients.

After confirming your choice, the selected users should be exported from WHMCS to Zendesk, and their 'Status' field will become modified as well. All users newly added to WHMCS will be automatically synchronized with Zendesk.

Tickets

The next option offered by our module is the export of tickets from WHMCS to Zendesk, proceeding to 'Tickets Export'. You will see here a list of all tickets which exist in your WHMCS and have not been synchronized with Zendesk yet. Thanks to the integration with Multibrand For WHMCS, you can also export tickets that are assigned to a particular brand. To do that, choose the proper brand from the dropdown menu.

Now, you can manually export all of the tickets available on the list or choose only some of them. Check boxes next to the tickets you are going to export and press 'Export' button as marked on the screen.

Next, confirm the default department you have chosen in the 'Ticket Settings' , or select one of the other available departments.

Since the 2.1.0 version of the module, all exported to Zendesk tickets will have a corresponding status. These are: Open → Open Closed → Closed On Hold → On Hold Solved → Solved In progress → Open Customre Reply → Open Pending → Pending Answered → Pending Default → Open Prior to V2.1.0: If a ticket has already been exported from WHMCS to Zendesk, it gets an "Open" status in Zendesk.

Logs

All module activities are recorded in 'Logs' . Note: You might have no logs visible here if there are no logged actions yet.

In case you no longer wish to see a particular log you can easily remove it. Select a particular entry and click on the bin icon as presented on the screen below.

In order to delete multiple logs at the same time you can simply take advantage of the 'Mass Remove Action'.

Support Tickets

Move to your client area. There, on the homepage, a 'Recent Support Tickets' box can be found. It presents the latest tickets available in your system. The visible tickets are marked with colors related to their current status.

Now, we will submit a ticket to show you the complete creation flow. Just like in the case of a standard WHMCS support ticket, choose the department. Note: For convenience, if you have only one department configured, you will be moved immediately to the ticket creation view.

Next, enter the subject, type in the ticket message and fill in any additional ticket fields that you feel are useful and will help you quickly receive a satisfactory answer. Submit the ticket.

A new ticket, sent with Zendesk For WHMCS module, is immediately visible in the Zendesk admin area.

Do not hesitate and send a reply to this ticket.

The client has received an answer. Note that the ticket status has been updated as well.

The module allows also the unlogged users to send tickets via the 'Contact Us' form. Such a ticket will be delivered to a department previously defined by the admin. Please refer to the 'Ticket Settings' section here to see how to configure the 'Contact Us' integration and department.

Emoji Support

Since the 2.0.0 version of the module, agents can use emojis (emoticons) without worrying that these will not be displayed to the clients in WHMCS. First, you need to enable support for them in your Zendesk Panel. Go to the 'Admin Center' → 'Objects and rules' → 'Tickets' → 'Settings' and tick the 'Turn on emoji text replacement' option. Remember to save the settings.

Now, your agent can insert emojis by typing an emoji code surrounded by colons (e.g. :smile:).

You can use a lot of different emojis. Press the 'Preview' button to see how they will look in the ticket.

After sending the reply, the emojis will be displayed in WHMCS to your client. Note: Due to the licensing issues, the appearance of emoticons used in the module is slightly different from those used by Zendesk itself. Moreover, a very small part of the emojis supported by Zendesk may not be yet included in the set used in the module. Click here to see the list of emojis supported by the module.

Your customers can also use emoji codes in WHMCS, but it is not possible to preview them before sending a ticket. The workaround for this inconvenience will be presented in the near future.

Tips

1. If you create a custom field in Zendesk, it will also be visible in WHMCS. Custom fields need to be enabled, visible, and editable by the client.

2. Since Zendesk does not fully support the WHMCS option to reopen closed tickets, 'Close ticket 4 days after status is set to solved' option is currently the only available one. To enable this option, proceed to Zendesk → Business Rules → Automations. Find the option and edit it.

Here you can configure the time period within which the tickets can be reopened by an answer from the client. Extend the maximum time to your needs.

3. Attachments are managed in Zendesk, therefore if you do not enable them in Zendesk, your clients will not be allowed to add them in the tickets. To enable attachments in Zendesk, please move to 'Zendesk' → 'Settings' → 'Tickets' → 'Attachments'. Then, enable both options: Customers can attach files Require authentication to download

4. If you would like to use multiple brands, first make sure you have 'Zendesk Support Multibrand' ' option enabled in your Zendesk account. Go to 'Zendesk' → 'Settings' → 'Account' → 'Branding'. Note that multibrand support may require the enterprise plan.

5. If you use SSO, you can still access your Zendesk panel in a normal way. Simply go to: https://YourZendeskSubdomain.zendesk.com/access/normal and enter your access details.

6. It is possible to change the name of a particular Zendesk department which is displayed while opening a ticket in the client area. All you need to do is to add the following lines to the language file. $_LANG['addonCA']['submitTicket']['ZendeskDepartmentName'] = 'NewDepartmentName'; $_LANG['ZendeskDepartmentName'] = 'NewDepartmentName'; As for example, we will change the name of the 'Feedback' department to 'General Feedback'.

We added these lines to the language file: $_LANG['addonCA']['submitTicket']['Feedback'] = 'General Feedback'; $_LANG['Feedback'] = 'General Feedback'; As a result, the name has been modified successfully.

7. There is the possibility to add translations for the 'Ticket Fields' created in Zendesk. Simply, complete the below pattern by providing the field name and its translation. $_LANG['fieldName'] = "Your Translation" Here are a few ready examples: $_LANG['Related Services'] = "Saistītais pakalpojums"; $_LANG['Priority'] = "Prioritāte"; $_LANG['Request priority'] = "Pieprasījuma prioritāte"; Once ready, add them to the language file and save the changes.

8. 'Shared Login Redirection' allows you to log in to the Zendesk panel using the URL redirection that is provided in the Zendesk panel. To find the 'Remote login URL' option, proceed to the Zendesk panel → Security → Single sign-on → JSON Web Token. With this option, we can use authorization from another website to access the Zendesk panel.

9. Cache time of the module can be adjusted to seconds directly in the "configuration.yml" file. Open the file at: modules/addons/Zendesk/app/Config/configuration.yml. The entered values are measured in seconds, if no value is entered in "cacheTime:", by default 5 minutes (300 seconds) is used.

Update Instructions

An essential guidance through the process of updating the module is offered here. Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues. Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability? There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment. Opt for the Open Source version of your Zendesk For WHMCS module to unlock these benefits. Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied. Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.

2. When you try to open a new ticket and you get the 'Unable to authenticate' error, this means that the user's email is already registered in Zendesk, but it has not been verified yet. To solve the problem, log in to your Zendesk admin area and verify the email by clicking 'Verify now' as presented on the screen below.

3. If you encounter a problem when performing the export of a lot of users, make sure you are not using the Zendesk trial account. This is due to Zendesk trial account limitations, where you cannot use the API endpoint to bulk import users or organizations. A '403 Forbidden' error is returned.

4. Some of the module elements may not reflect immediate changes made in the Zednesk panel. This is due to the use of cache to limit the number of queries to APIs. E.g. the cache refreshing time for the ticket list and replies is 30 seconds. The update of brands, ticket fields, and departments can take up to 18 minutes and clients even 54 minutes. If you need the immediate cache refreshment, go to the 'Ticket Settings' or save 'Server Settings' again.

5. If you are using the 'Contact Us Integration' option with Zendesk, you must remember to previously remove the standard WHMCS settings for this option. Move to WHMCS → Setup → General Settings → Mail and remove the 'Presales Form Destination' and 'Presales Contact Form Email' input. Otherwise, the visitor will be redirected to a login page.

6. We do not recommend using Zendesk For WHMCS module with Resellers Center For WHMCS. Integration between the two modules is hampered due to specific features of Resellers Center For WHMCS and its individual workflow.

7. The SSO only works for end users, it cannot be enabled for the staff login attempts.