Personal tools
Namespaces

Variants
Actions

Zendesk For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 31: Line 31:
 
|style="padding: 0px 0px 10px 30px;"|✔ List Recent Tickets
 
|style="padding: 0px 0px 10px 30px;"|✔ List Recent Tickets
 
|}
 
|}
−
*'''Integration:'''
+
*'''Admin Area Features:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Configure And Test Server Connection
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Disable SSL Verification
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Define Module Behavior
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Define Ticket Status Colors
 +
|}
 +
*'''Integration Features:'''
 
{|
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ Single Sign On (SSO) Integration
 
|style="padding: 10px 0px 0px 30px;"|✔ Single Sign On (SSO) Integration
Line 42: Line 55:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Disable SSL Verification Host/Peer In cURL
+
|style="padding: 0px 0px 0px 30px;"|✔ Transfer Attachments Settings
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Convert Markdowns To HTML
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
Line 60: Line 76:
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|Installation and configuration of Zendesk For WHMCS won't take you longer than 10 minutes.<br />
+
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and configure Zendesk For WHMCS.''' <br />
−
We will guide you step by step through the whole process.
+
We will guide you step by step through the whole installation and configuration process.  
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Zendesk For WHMCS.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Zendesk For WHMCS.'''
 
|}
 
|}
 
{|
 
{|
Line 71: Line 88:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''<br />
−
Files in your WHMCS directory should look like this.
+
Files in your WHMCS directory should look like on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:Z2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Afterwards log in to your Zendesk admin area in order to enable API access.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Zendesk For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
Go to '' 'Manage' '' → '' 'API' '' which is located in the '' 'Channels' '' section and enable '' 'Token Access' ''. Remember to save the changes.<br />
+
File is located in '' 'modules/addons/zendesk/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
−
'''IMPORTANT:''' Copy and keep your API token in a safe place. You will need it in a moment to complete the installation of the module.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:Z3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. Now go to '' 'Manage' '' → '' 'Security' '' which is located in the '' 'Settings' '' section and enable '' 'Single-Sign On' ''.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file. '' '''<br />
−
Here you can also check your remote login URL and remote logout URL. Don't forget to press '' 'Save tab' '' at the bottom of the screen.
+
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → '' 'My Products'. ''  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:Z4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:Z2_4.png]]
 
|}
 
|}
 +
 +
==Activation==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''5. Scroll down to the bottom of page and press '' 'generate a new token' '' or use an existing one.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''5. Now, you have to activate the module in your WHMCS system.'''<br />
 +
Log in to your WHMCS admin area and proceed to '' 'Setup' '' → '' 'Addon Modules'. ''<br />
 +
Afterwards, find '' 'Zendesk' '' and press '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:Z5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Copy and keep your '' 'shared secret' '' in a safe place. We will need it in the next step.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''6. In the next step you need to permit access to this module.'''<br />
−
'''IMPORTANT:''' Make sure that you have copied the entire secret. It's longer than shown on the screen below.
+
To do so, click on '' 'Configure' '' button, tick checkboxes to assign desired admin roles.<br /
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:Z6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. Afterwards you need to configure one file. To do so, go to '' 'your_whmcs/modules/support/zendesk' '' and modify '' 'configuration.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. Finally, move to '' 'Setup' → 'General Settings' → 'Support'. ''<br />
−
Below we will briefly describe critical variables for proper operation of the module:<br />
+
There choose '' 'Zendesk' '' support module form dropdown menu. Save changes.
−
'''$token''' - enter your API token obtained in the step 3<br />
+
−
'''$shared_secret''' - enter your shared secret obtained in the step 6<br />
+
−
'''$zendesk_for_whmcs_licensekey''' = enter your license key here<br />
+
−
Other modifications aren't mandatory.<br />
+
−
All necessary information about additional changes like e.g. account name, ticket status colors or email updates you will find in the configuration file as shown on the screen below.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:Z7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_6_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. The last step is performed directly in WHMCS.'''<br />
+
|style="padding: 0px 0px 30px 15px;"|'''8. You have just successfully installed Zendesk For WHMCS!'''
−
Log in to your system, go to '' 'Setup' '' → '' 'General Settings' '' → '' 'Support' '', choose '' 'Zendesk' '' from a dropdown menu and save changes.
+
|}
 +
 
 +
==Configuration==
 +
{|
 +
|style="padding: 20px 0px 20px 15px;"|'''Now you have to configure your newly installed module.'''<br/>
 +
Before we proceed to the configuration itself, you have to generate your API details to connect with your Zendesk account.
 +
|}
 +
===API Connection===
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Firstly, log in to your Zendesk admin area in order to enable API access.<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_8.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Go to '' 'Admin' '' → '' 'Channels:' '' '' 'API'. '' There, in  '' 'Settings' '' section find '' 'Token Access' ''  and enable it.<br />
 +
Add new token or use existing one. Copy an active API token.<br/>
 +
'''IMPORTANT:''' Copy and keep your API token in a safe place. You will need it in a moment to complete the configuration of the module.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_9.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Now go to '' 'Settings' '' → '' 'Security' '' section and enable '' 'Single-Sign On'. ''<br />
 +
Here you can also check your remote login URL and remote logout URL.<br/> Don't forget to press '' 'Save tab', '' you will find at the bottom of the page.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_10.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Scroll down to the bottom of page and find '' 'Shared Secret' '' section. Press '' 'Regenerate' '' to get a new shared secret token or use an existing one.<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_11.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Copy and keep your '' 'shared secret' '' in a safe place. We will need it in the next step.<br />
 +
'''IMPORTANT:''' Make sure that you have copied the entire secret.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_12.png]]
 +
|}
 +
 
 +
===Server Configuration===
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Now, that you have safely stored API and Shared Secret tokens, you may move to the second part of configuration.<br/>
 +
Proceed to '' 'Addons' → 'Zendesk' → 'Server Configuration', '' here you have to enter any data required to connect your WHMCS with Zendesk server.<br/><br/>
 +
''Note! If you have used previous versions of our product, you have to copy the tokens from your 'configuration.php' file into the addon to do the update.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Enter your Zendesk details:
 +
*Account Name - this is your subdomain e.g. in ''<nowiki>https://modulesgarden.zendesk.com</nowiki>'' account name will be ''modulesgarden''
 +
*Admin Username - administrator's email used to log into your Zendesk account
 +
*API Token - API key generated in the previous steps
 +
*Shared Secret Token - Shared Secret key generated in the previous steps<br/>
 +
*Disable SSL Connection - check this box if you want to turn off SSL certificate verification.<br/>
 +
Finally, test connection, if it is successful save the changes.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:Z8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_14.png]]
 
|}
 
|}
 
{|
 
{|
Line 129: Line 203:
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 15px 0px;"|Once Zendesk For WHMCS is installed and configured, you can create/update your ticket departments and begin to use it.<br />
+
|style="padding: 10px 0px 30px 15px;"|'''Once Zendesk For WHMCS is installed and connection configured, you can create/update your ticket departments and begin using it.'''<br />
 
Each ticket department you create in the Zendesk will be available for your customers in WHMCS client area.
 
Each ticket department you create in the Zendesk will be available for your customers in WHMCS client area.
 
|}
 
|}
 +
==Settings==
 +
===WHMCS===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Let's see what our Zendesk For WHMCS can do. Firstly, you can create and modify ticket fields which will show up in WHMCS while creating a new ticket.<br />
+
|style="padding: 0px 0px 15px 15px;"|Before you start your actual work on support tickets with Zendesk For WHMCS, move again to '' 'Addons' → 'Zendesk' → 'Ticket Settings'. ''<br/>
 +
This section of the addon allows easy and comfortable management of the way tickets are displayed in your client are, their visibility, sorting etc.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|In the first box ''''' 'Options', ''''' you may enable some basic settings that will be applied to tickets view in the client area.<br/> Let's now discuss their functionality in details:
 +
*Show Solved Tickets - if you enable this option, solved tickets will be displayed on the list of the latest tickets together with the other ones (e.g. open/new tickets etc.);
 +
*Shared Login Redirection - if enabled, user is redirected to Zendesk panel after successful shared login
 +
*Update Client Credentials - if client's email or name is updated in WHMCS, it's updated in Zendesk accordingly
 +
*Replies Descending Order - enable this option and ticket replies will be sorted by date in descending order when viewing a ticket
 +
*Template Name - choose a custom template that you wish to use instead of a default one (any predefined by WHMCS)
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_16.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Next to the '' 'Options' '' box you will find a box where you can assign some colors to a specific ticket status.<br/>
 +
Click on the field to choose a color from the palette of colors or type in the number of the color you like.<br/>
 +
Tickets of each status will be marked with selected colors on homage.<br/><br/>
 +
Remember to save the changes if you make any changes in ticket settings.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_17.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Tickets of each status are now marked with selected colors on homepage.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:Z2_18.png]]
 +
|}
 +
 
 +
===Zendesk===
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|You can also manage ticket fields, that are available in WHMCS on a new ticket form, directly in Zendesk.<br />
 +
Move to '' 'Zendesk' → 'Admin' → 'Manage' → 'Ticket Fields'. '' On this site you can activate/deactivate/edit any system and custom fields or add new ones. <br />
 
For test purposes we activated and adjusted '' 'Priority' '' field according to our needs.
 
For test purposes we activated and adjusted '' 'Priority' '' field according to our needs.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:Z9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_19.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|As you can see on the screen below, new field appeared in WHMCS client area. Let's send the ticket.
+
|style="padding: 0px 0px 20px 15px;"|As you can see on the screen below, a new field appeared in WHMCS client area.<br/>Edit/add ticket fields to adjust the ticket form perfectly to your needs.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_20.png]]
 
|}
 
|}
 +
==Support Tickets==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Ticket has successfully appeared in your Zendesk admin area. Do not let him wait long unanswered.
+
|style="padding: 10px 0px 20px 15px;"|Move to your Client Area. There, on your homepage, is a '' 'Recent Support Tickets' '' box. <br/>
 +
You will find the latest five tickets available in your system. The visible tickets are marked with colors related to their current status and sorted in descending order. <br/>
 +
Remember that the view of of this box depends on the configuration you have set up in your addon.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_21.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Let's send an answer to our fellow Tester.
+
|style="padding: 0px 0px 20px 15px;"|Now, we will create a ticket message to show the flow. Just like in case of standard WHMCS support ticket, choose department,<br> then enter subject, type in the ticket message and fill out any additional ticket fields that you feel are useful and will help you get a satisfactory answer faster.<br/>Submit the ticket.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_22.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Our customer received an answer with updated ticket status.
+
|style="padding: 0px 0px 20px 15px;"|A new ticket, sent with Zendesk For WHMCS module, is immediately visible in Zendesk admin area.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_23.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|As you noticed management of Zendesk For WHMCS is very simple and intuitive. Now you are ready to offer your customers a new level of support!
+
|style="padding: 0px 0px 20px 15px;"|Do not hesitate and send a reply to this ticket.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Z2_24.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Client has received an answer. Note that the ticket status has been updated as well.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:Z2_25.png]]
 
|}
 
|}
  
−
==How To Update==
+
<!--
 +
=How To Update=
 
{|
 
{|
 
|style="padding: 20px 0px 20px 15px;"|Updating Zendesk For WHMCS to newest version is quite simple.<br />
 
|style="padding: 20px 0px 20px 15px;"|Updating Zendesk For WHMCS to newest version is quite simple.<br />
Line 190: Line 315:
 
|style="padding: 0px 0px 30px 25px;"|[[File:Z13_1.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:Z13_1.png]]
 
|}
 
|}
 +
-->
  
 
=Tips=
 
=Tips=
Line 202: Line 328:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|4. You can translate ticket status names through creating '' 'zendesk_lang.txt' '' file in '' 'your_whmcs/lang' '' directory.<br />
+
|style="padding: 0px 0px 10px 15px;"|5. Since Zendesk does not fully support WHMCS option to reopen closed tickets, '' 'Close ticket 4 days after status is set to solved' ''<br/>option is currently the only possibility to get around it. To enable configure this option proceed to ''Zendesk → Business Rules → Automations.'' <br/>Find there the option and edit it.
−
These are translation variables used by Zendesk module. You can add them to the bottom of any language file you would like to use.<br />
+
−
Just translate the right side of the equal sign within the quotes. '''Do not change left side variables.'''<br />
+
−
 
+
−
$_LANG["zendesk_ticket_status_new"]    = "New";<br />
+
−
$_LANG["zendesk_ticket_status_open"]    = "Open";<br />
+
−
$_LANG["zendesk_ticket_status_pending"] = "Pending";<br />
+
−
$_LANG["zendesk_ticket_status_hold"]    = "Hold";<br />
+
−
$_LANG["zendesk_ticket_status_solved"]  = "Solved";<br />
+
−
$_LANG["zendesk_ticket_status_closed"]  = "Closed";
+
−
 
+
−
Setting above is optional. If translations are not set, the default english values are displayed, straight from Zendesk.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"|5. Since Zendesk does not fully support WHMCS option to reopen closed tickets, '' ' Close ticket 4 days after status is set to solved' ''<br.>option is currently the only possibility to get around it. To enable configure this option proceed to ''Zendesk → Business Rules → Automations.'' <br/>Find there the option and edit it.
+
 
|}
 
|}
 
{|
 
{|

Revision as of 16:51, 25 November 2015

Article update is ongoing on this page, watch out for broken links and unclear descriptions!
We are sorry for the inconvenience caused.

Contents

About Zendesk For WHMCS

Zendesk For WHMCS allows your customers to use a complex support system solution in your own WHMCS.

With our module your clients will be able to manage Zendesk tickets as if they were a part of your system.
This product replaces a standard WHMCS client area support system with Zendesk, allowing you to easily manage all the tickets.

  • Client Area Features:
✔ View Zendesk Departments
✔ Open New Ticket
✔ Manage Existing Tickets
✔ Fill Out Zendesk Ticket Fields
✔ Attach Files To Ticket
✔ List Recent Tickets
  • Admin Area Features:
✔ Configure And Test Server Connection
✔ Disable SSL Verification
✔ Define Module Behavior
✔ Define Ticket Status Colors
  • Integration Features:
✔ Single Sign On (SSO) Integration
✔ Synchronize User Accounts Between WHMCS And Zendesk
✔ Transfer Ticket Fields Settings
✔ Transfer Attachments Settings
✔ Convert Markdowns To HTML
  • General Info:
✔ Custom Templates Support
✔ Multi-Language Support
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V5 and V6

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 your client area and download Zendesk For WHMCS.
Z1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like on the following screen.

Z2 2.png
3. When you install Zendesk For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/addons/zendesk/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

Z2 3.png
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 your client area → 'My Products'.

Z2 4.png

Activation

5. Now, you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area and proceed to 'Setup' → 'Addon Modules'.
Afterwards, find 'Zendesk' and press 'Activate' button.

Z2 5.png
6. In the next step you need to permit access to this module.

To do so, click on 'Configure' button, tick checkboxes to assign desired admin roles.<br /

Z2 6.png
7. Finally, move to 'Setup' → 'General Settings' → 'Support'.

There choose 'Zendesk' support module form dropdown menu. Save changes.

Z2 6 1.png
8. You have just successfully installed Zendesk For WHMCS!

Configuration

Now you have to configure your newly installed module.

Before we proceed to the configuration itself, you have to generate your API details to connect with your Zendesk account.

API Connection

Firstly, log in to your Zendesk admin area in order to enable API access.
Z2 8.png
Go to 'Admin' → 'Channels:' 'API'. There, in 'Settings' section find 'Token Access' and enable it.

Add new token or use existing one. Copy an active API token.
IMPORTANT: Copy and keep your API token in a safe place. You will need it in a moment to complete the configuration of the module.

Z2 9.png
Now go to 'Settings' → 'Security' section and enable 'Single-Sign On'.

Here you can also check your remote login URL and remote logout URL.
Don't forget to press 'Save tab', you will find at the bottom of the page.

Z2 10.png
Scroll down to the bottom of page and find 'Shared Secret' section. Press 'Regenerate' to get a new shared secret token or use an existing one.
File:Z2 11.png
Copy and keep your 'shared secret' in a safe place. We will need it in the next step.

IMPORTANT: Make sure that you have copied the entire secret.

Z2 12.png

Server Configuration

Now, that you have safely stored API and Shared Secret tokens, you may move to the second part of configuration.

Proceed to 'Addons' → 'Zendesk' → 'Server Configuration', here you have to enter any data required to connect your WHMCS with Zendesk server.

Note! If you have used previous versions of our product, you have to copy the tokens from your 'configuration.php' file into the addon to do the update.

Z2 13.png
Enter your Zendesk details:
  • Account Name - this is your subdomain e.g. in https://modulesgarden.zendesk.com account name will be modulesgarden
  • Admin Username - administrator's email used to log into your Zendesk account
  • API Token - API key generated in the previous steps
  • Shared Secret Token - Shared Secret key generated in the previous steps
  • Disable SSL Connection - check this box if you want to turn off SSL certificate verification.

Finally, test connection, if it is successful save the changes.

Z2 14.png
Good job! Now your WHMCS is connected with Zendesk support system.

Management

Once Zendesk For WHMCS is installed and connection configured, you can create/update your ticket departments and begin using it.

Each ticket department you create in the Zendesk will be available for your customers in 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 easy and comfortable management of the way tickets are displayed in your client are, their visibility, sorting etc.

Z2 15.png
In the first box 'Options', you may enable some basic settings that will be applied to tickets view in the client area.
Let's now discuss their functionality in details:
  • Show Solved Tickets - if you enable this option, solved tickets will be displayed on the list of the latest tickets together with the other ones (e.g. open/new tickets etc.);
  • Shared Login Redirection - if enabled, user is redirected to Zendesk panel after successful shared login
  • Update Client Credentials - if client's email or name is updated in WHMCS, it's updated in Zendesk accordingly
  • Replies Descending Order - enable this option and ticket replies will be sorted by date in descending order when viewing a ticket
  • Template Name - choose a custom template that you wish to use instead of a default one (any predefined by WHMCS)
Z2 16.png
Next to the 'Options' box you will find a box where you can assign some colors to a specific ticket status.

Click on the field to choose a color from the palette of colors or type in the number of the color you like.
Tickets of each status will be marked with selected colors on homage.

Remember to save the changes if you make any changes in ticket settings.

Z2 17.png
Tickets of each status are now marked with selected colors on homepage.
Z2 18.png

Zendesk

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/edit any system and custom fields or add new ones.
For test purposes we activated and adjusted 'Priority' field according to our needs.

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

Support Tickets

Move to your Client Area. There, on your homepage, is a 'Recent Support Tickets' box.

You will find the latest five tickets available in your system. The visible tickets are marked with colors related to their current status and sorted in descending order.
Remember that the view of of this box depends on the configuration you have set up in your addon.

Z2 21.png
Now, we will create a ticket message to show the flow. Just like in case of standard WHMCS support ticket, choose department,
then enter subject, type in the ticket message and fill out any additional ticket fields that you feel are useful and will help you get a satisfactory answer faster.
Submit the ticket.
Z2 22.png
A new ticket, sent with Zendesk For WHMCS module, is immediately visible in Zendesk admin area.
Z2 23.png
Do not hesitate and send a reply to this ticket.
Z2 24.png
Client has received an answer. Note that the ticket status has been updated as well.
Z2 25.png


Tips

1. If you create a custom field in Zendesk, it will be also visible in WHMCS. Custom fields need to be enabled/visible/editable_by_client.
2. When you add ' |clientservice' at the end of the custom field title, a select with list of products and domains will show up.
3. Module supports 'default' and 'portal' templates but you can create and set up your own template.
5. Since Zendesk does not fully support WHMCS option to reopen closed tickets, 'Close ticket 4 days after status is set to solved'
option is currently the only possibility to get around it. To enable configure this option proceed to Zendesk → Business Rules → Automations.
Find there the option and edit it.
Z16.png
Here you can configure the time until when tickets can be reopened by an answer from teh client.
Maximum possible time is now 672 hours (28 days).
Z15.png

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 error 'Unable to authenticate' , this means that the user's email is already registered in Zendesk, but it's not verified yet.

To solve the problem log in to your Zendesk admin area and verify the email through clicking 'Verify now' as presented on the screen below.

Z14.png
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Zendesk_For_WHMCS&oldid=21527"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Zendesk For WHMCS