Zendesk For WHMCS
From ModulesGarden Wiki
(Difference between revisions)
| Line 4: | Line 4: | ||
=About [http://www.modulesgarden.com/products/whmcs/zendesk/features Zendesk For WHMCS]= | =About [http://www.modulesgarden.com/products/whmcs/zendesk/features Zendesk For WHMCS]= | ||
{| | {| | ||
| − | |style="padding: 10px 0px 10px 0px;"|'''Zendesk For WHMCS''' | + | |style="padding: 10px 0px 10px 0px;"|'''Zendesk For WHMCS''' allows your customers to use a complex support system solution in your own WHMCS.<br /> |
| − | + | With our module your clients will be able to manage Zendesk tickets as if they were a part of your system.<br /> | |
| − | + | This product replaces a standard WHMCS client area support system with Zendesk, allowing you to easily manage all the tickets. | |
|} | |} | ||
<!-- fixed --> | <!-- fixed --> | ||
| Line 20: | Line 20: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Fill | + | |style="padding: 0px 0px 0px 30px;"|✔ Fill Out Zendesk Ticket Fields |
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 36: | Line 33: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Toggle SSL | + | |style="padding: 0px 0px 0px 30px;"|✔ Toggle SSL Verification |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Define Available Support Departments |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 57: | Line 48: | ||
|} | |} | ||
{| | {| | ||
| − | + | |style="padding: 0px 0px 0px 30px;"|✔ Define Module Behavior | |
| − | + | ||
| − | + | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Define Module Behavior | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 10px 30px;"|✔ | + | |style="padding: 0px 0px 10px 30px;"|✔ Define Ticket Status Colors |
|} | |} | ||
*'''Integration Features:''' | *'''Integration Features:''' | ||
| Line 103: | Line 76: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 10px 30px;"|✔ Convert Markdowns To HTML | + | |style="padding: 0px 0px 10px 30px;"|✔ Convert Markdowns To HTML |
|} | |} | ||
*'''General Info:''' | *'''General Info:''' | ||
{| | {| | ||
| − | |style="padding: 10px | + | |style="padding: 10px 0px 0px 30px;"|✔ Custom Templates Support |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 119: | Line 86: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5. | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.4 Up To PHP 7 |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS | + | |style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7 | + | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V6 and V7 |
|} | |} | ||
=Installation and Configuration= | =Installation and Configuration= | ||
{| | {| | ||
| − | |style="padding: 10px 0px | + | |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 installation and configuration process. | We will guide you step by step through the whole installation and configuration process. | ||
|} | |} | ||
==Installation== | ==Installation== | ||
{| | {| | ||
| − | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to | + | |style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Zendesk For WHMCS.''' |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z1.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.<br/>It does not apply to open source versions.<br/> |
| − | '' '''Note''': You can check | + | '' '''Note''': You can check current PHP version in your WHMCS. To do so proceed to ''' 'Utilities' → 'System' → 'PHP Info'.''' |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_2.png]] |
|} | |} | ||
{| | {| | ||
| Line 152: | Line 119: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_2_1.png]] |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''4. When you install Zendesk For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br /> |
| + | File is located in '' 'modules/addons/Zendesk/license_RENAME.php'.'' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. '' | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_3.png]] |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit the previously renamed '' 'license.php' file. '' '''<br /> |
| + | 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 30px 25px;"|[[File:Z2_4.png]] | ||
|} | |} | ||
| Line 173: | Line 143: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_5.png]] |
|} | |} | ||
{| | {| | ||
| Line 180: | Line 150: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_6.png]] |
|} | |} | ||
{| | {| | ||
| Line 188: | Line 158: | ||
==Configuration== | ==Configuration== | ||
{| | {| | ||
| − | |style="padding: 20px 0px | + | |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. | Before we proceed to the configuration itself, you have to generate your API details to connect with your Zendesk account. | ||
|} | |} | ||
===API Connection=== | ===API Connection=== | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |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: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_8.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|Go to '' 'Admin' '' → '' 'Channels:' '' '' 'API'. '' There, in | + | |style="padding: 0px 0px 15px 15px;"|Go to '' 'Admin' '' → '' 'Channels:' '' '' 'API'. '' There, in '' 'Settings' '' section find '' 'Token Access' '' and enable it.<br /> |
| − | Add a new token or use an existing one | + | Add a new token or use an 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: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_9.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|Now go to '' 'Settings' '' → '' 'Security' '' section | + | |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.<br /> |
| + | Scroll down to the bottom of the 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: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_10.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |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 /> |
| + | ''Note that Shared secret is not required for Zendesk module to work itself. It is needed for SSO only.'' | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_12.png]] |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
| − | ===Server | + | ===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 | + | |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 process.<br/> |
| − | Proceed to '' 'Addons' → 'Zendesk' → 'Server | + | 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: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_13.png]] |
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|Enter your Zendesk details: | |style="padding: 0px 0px 15px 15px;"|Enter your Zendesk details: | ||
| − | *'''Account Name''' - this is | + | *'''Account Name''' - this is your subdomain e.g. in ''<nowiki>https://modulesgarden.zendesk.com</nowiki>'' your account name will be ''modulesgarden'' |
| − | *''' | + | *'''Admin Username''' - administrator's email used to log into your Zendesk account |
| − | *'''API Token''' - | + | *'''API Token''' - API key generated in the previous steps |
| − | *'''Shared Secret Token''' - | + | *'''Shared Secret Token''' - Shared Secret key generated in the previous steps |
| − | *'''SSL Connection''' - | + | *'''Enable SSL Connection''' - check this box if you want to turn on SSL certificate verification |
| − | + | *'''Brand''' - if you have [https://support.zendesk.com/hc/en-us/articles/204108983 Zendesk Multibrand] feature enabled on your account you can choose a brand here | |
| + | Finally, test connection, if it is successful save the changes. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_14.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|Finally, move to '' 'Setup' → 'General Settings' → 'Support'.<br/> |
| − | + | There choose '' 'Zendesk' '' support module form dropdown menu. Save changes.<br/> | |
| − | + | ''From now on, your clients will see Zendesk tickets and departments (not WHMCS).'' | |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_6_1.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 15px;"|'''Good job! Now your WHMCS is connected with | + | |style="padding: 0px 0px 30px 15px;"|'''Good job! Now your WHMCS is connected with Zendesk support system'''. |
|} | |} | ||
=Management= | =Management= | ||
{| | {| | ||
| − | |style="padding: 10px 0px 30px 15px;"|'''Once Zendesk For WHMCS is installed and | + | |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 Zendesk will be available for your customers in | + | Each ticket department you create in Zendesk will be available for your customers in WHMCS client area. |
|} | |} | ||
==Settings== | ==Settings== | ||
| Line 277: | Line 236: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|Before you start your actual work on support tickets with Zendesk For WHMCS, move again to '' 'Addons' → 'Zendesk' → 'Ticket Settings'. ''<br/> | |style="padding: 10px 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 | + | This section of the addon allows easy and comfortable management of the way tickets are displayed in your client area, their visibility, sorting etc. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_15.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |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, 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.); |
| − | + | *Shared Login Redirection - if enabled, user is redirected to Zendesk panel after successful shared login | |
| − | + | *Update Client Credentials - if client's email is updated in WHMCS, it's updated in Zendesk accordingly ''(name is also updated but only if email is changed)'' | |
| − | * | + | *Replies Descending Order - enable this option and ticket replies will be sorted by date in descending order when viewing a ticket |
| − | + | *Template Name - if you decide to change your current template in your WHMCS, then change it here as well. Your custom templates are also available. | |
| − | * | + | *Allowed Departments - select which of your departments from Zendesk shall be available in WHMCS ticket system |
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_16.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |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 or type in the number of the color you like.<br/><br/> | + | Click on the field to choose a color from the palette or type in the number of the color you like.<br/> |
| − | Remember to save the changes if you | + | Tickets of each status will be marked with selected colors on homepage.<br/><br/> |
| + | Remember to save the changes if you make any changes in ticket settings. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_17.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|Tickets | + | |style="padding: 0px 0px 20px 15px;"|Tickets of each status are now marked with selected colors on homepage. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_18.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|Below the '' 'Status Color' '' you will find a box where you can define what the default department for exported tickets will be.<br/> |
| + | You can choose from your existing Zendesk departments.<br/><br/> | ||
| + | Remember to click '' 'Save Changes' '' button before you move to another section. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:Z27.png]] |
|} | |} | ||
| − | === | + | ===Zendesk=== |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
{| | {| | ||
| − | |style="padding: 0px | + | |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. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_19.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 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 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:Z2_20.png]] |
|} | |} | ||
==Export== | ==Export== | ||
{| | {| | ||
| − | |style="padding: 10px 0px | + | |style="padding: 10px 0px 5px 15px;"|Our module allows to export data gathered in your WHMCS, more specifically, all the users and tickets generated before the installation of the product.<br/> |
| − | Read the below points to learn what data can be synchronized with Zendesk and what are the possible means of such | + | Read the below points to learn what data can be synchronized with Zendesk and what are the possible means of such synchronizations. |
|} | |} | ||
===Users=== | ===Users=== | ||
| Line 387: | Line 304: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z19.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|Now, you can manually export all of the users available on the list or choose only some of them.<br/>Check boxes next to the users you are going to export and press | + | |style="padding: 0px 0px 15px 15px;"|Now, you can manually export all of the users available on the list or choose only some of them.<br/>Check boxes next to the users you are going to export and press '' 'Export' '' button as marked on the screen. |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ZN20.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|If a user has already been exported from WHMCS to Zendesk, they will no longer be visible on the list.<br/> All users newly added to WHMCS will be automatically synchronized with Zendesk unless otherwise stated in '' 'Synchronization Settings'.''<br/><br/> |
| + | After the successful export you may no longer see your users. To change the view proceed to '' 'Toggle Filters' '' to see whether the box defining the view is checked. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z21.png]] |
|} | |} | ||
| − | |||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 20px 15px;"|When the box is not checked, you will see the list of users that have been exported. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:Z22.png]] |
|} | |} | ||
| + | |||
| + | ===Tickets=== | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 10px 0px 15px 15px;"|The next option offered by our module is the export of tickets from WHMCS to Zendesk, proceed to '' 'Tickets Export'. ''<br/>If you are using Zendesk For WHMCS for the first time, you will see here a list of all tickets which exist in your WHMCS and have not been synchronized with Zendesk yet. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z23.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|Now, you can manually export all of the tickets available on the list or choose only some of them.<br/>Check boxes next to the tickets you are going to export and press '' 'Export' '' button as marked on the screen. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z24.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|If a ticket has already been exported from WHMCS to Zendesk, they will no longer be visible on the list.<br/> All tickets newly created to WHMCS will be automatically synchronized with Zendesk unless otherwise stated in '' 'Synchronization Settings'.''<br/><br/> |
| − | + | After the successful export you may no longer see your tickets. To change the view proceed to '' 'Toggle Filters' '' to see whether the box defining the view is checked. | |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z25.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"| | + | |style="padding: 0px 0px 20px 15px;"|When the box is not checked, you will see the list of tickets that have been exported. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px 25px;"|[[File: | + | |style="padding: 0px 0px 30px 25px;"|[[File:Z26.png]] |
|} | |} | ||
==Support Tickets== | ==Support Tickets== | ||
{| | {| | ||
| − | |style="padding: 10px 0px | + | |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 tickets available in your system. The visible tickets are marked with colors related to their current status. | |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_21.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |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: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_22.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |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: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_23.png]] |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| Line 481: | Line 377: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2_24.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"| | + | |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: | + | |style="padding: 0px 0px 30px 25px;"|[[File:Z2_25.png]] |
|} | |} | ||
| − | = | + | |
| + | <!-- | ||
| + | =How To Update= | ||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 20px 0px 20px 15px;"|Updating Zendesk For WHMCS to newest version is quite simple.<br /> |
| − | + | '''1. Firstly download the newest version from your client area.''' | |
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z1.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |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. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:Z2.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|'''3. Copy settings from '' 'configuration.php' '' to '' 'configuration_RENAME.php' ''.'''<br /> |
| + | Both files are located at '' 'your_whmcs\modules\support\zendesk' ''.<br /> | ||
| + | Afterwards, remove '' 'configuration.php' '' file and rename '' 'configuration_RENAME.php' '' to '' 'configuration.php' ''. | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 25px;"|[[File:Z13_1.png]] |
|} | |} | ||
| + | --> | ||
| + | |||
| + | =Tips= | ||
{| | {| | ||
| − | |style="padding: 0px | + | |style="padding: 10px 0px 10px 15px;"|1. If you create a custom field in Zendesk, it will also be visible in WHMCS. Custom fields need to be enabled/visible/editable_by_client. |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 10px 15px;"|2. When you add '' ' |clientservice' '' at the end of the custom field title, a select with list of products and domains will show up. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 15px 15px;"|3. 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. |
| − | + | ||
|} | |} | ||
| − | |||
| − | |||
{| | {| | ||
| − | |style="padding: | + | |style="padding: 0px 0px 20px 15px;"|[[File:Z16.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|Here you can configure the time until when tickets can be reopened by an answer from the client.<br/> Maximum possible time is now 672 hours (28 days). |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 15px;"|[[File:Z30.png]] |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|4. Attachments are managed in Zendesk, therefore if you do not enable them in Zendesk, your clients will not be allowed to add any in their tickets.<br/> |
| − | + | To enable attachments in Zendesk please move to '' 'Zendesk' → 'Settings' → 'Tickets' → 'Attachments'.'' There enable both options:<br/> | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | To enable attachments in Zendesk | + | |
*Customers can attach files | *Customers can attach files | ||
*Require authentication to download | *Require authentication to download | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|[[File: | + | |style="padding: 0px 0px 20px 15px;"|[[File:Z17.png]] |
|} | |} | ||
| − | |||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"| | + | |style="padding: 0px 0px 20px 15px;"|In case you can see only one option, make sure you have your '' 'Help Center' '' active. |
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 20px 15px;"|[[File: | + | |style="padding: 0px 0px 20px 15px;"|[[File:Z18.png]] |
|} | |} | ||
| − | |||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"| | + | |style="padding: 0px 0px 15px 15px;"|5. If you would like to use multi brands, first make sure you have '' 'Zendesk Support multibrand' ''' option enabled in your Zendesk account.<br/> |
| − | Go to '' 'Zendesk' → 'Settings' → 'Account' → 'Branding'. | + | Go to '' 'Zendesk' → 'Settings' → 'Account' → 'Branding'.'' Note that multibrand support may require enterprise plan. |
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px | + | |style="padding: 0px 0px 30px 15px;"|[[File:Z30.png]] |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
| Line 583: | Line 466: | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 15px 15px;"|2. When you try to open a new ticket and you get | + | |style="padding: 0px 0px 15px 15px;"|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.<br /> |
| − | To solve the problem | + | 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. |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
{| | {| | ||
| − | |style="padding: 0px 0px 30px | + | |style="padding: 0px 0px 30px 25px;"|[[File:Z14.png]] |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
|} | |} | ||
Revision as of 13:53, 11 April 2018
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. |
- 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 |
| ✔ Toggle SSL Verification |
| ✔ Define Available Support Departments |
| ✔ Manually Export To Zendesk: |
| ✔ WHMCS Clients |
| ✔ WHMCS Tickets |
| ✔ Define Module Behavior |
| ✔ Define Ticket Status Colors |
- Integration Features:
| ✔ Single Sign On (SSO) Integration |
| ✔ Automatically Export To Zendesk: |
| ✔ New Tickets |
| ✔ Clients On Tickets Creation |
| ✔ Synchronize Ticket Responses Between WHMCS And Zendesk |
| ✔ Transfer Ticket Fields Settings |
| ✔ Transfer Attachments Settings |
| ✔ Convert Markdowns To HTML |
- General Info:
| ✔ Custom Templates Support |
| ✔ Multi-Language Support |
| ✔ Supports PHP 5.4 Up To PHP 7 |
| ✔ Supports WHMCS Templates Five and Six |
| ✔ Supports WHMCS V6 and V7 |
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. |
|
| 2. In the downloaded file you will find two packages that support different PHP versions. As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6. It does not apply to open source versions. Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'. |
|
| 3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory. The content of PHP version files should look like this. |
|
| 4. 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'. |
|
| 5. 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'. |
|
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'. |
|
| 7. 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. |
|
| 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. |
|
| Go to 'Admin' → 'Channels:' 'API'. There, in 'Settings' section find 'Token Access' and enable it. Add a new token or use an existing one. Copy an active API token. |
|
| Now go to 'Settings' → 'Security' section and enable 'Single-Sign On'. Here you can also check your remote login URL and remote logout URL. |
|
| Copy and keep your 'shared secret' in a safe place. We will need it in the next step. Note that Shared secret is not required for Zendesk module to work itself. It is needed for SSO only. |
|
Server Configuration
| Now, that you have safely stored API and Shared Secret tokens, you may move to the second part of configuration process. Proceed to 'Addons' → 'Zendesk' → 'Server Configuration', here you have to enter any data required to connect your WHMCS with Zendesk server. |
|
Enter your Zendesk details:
Finally, test connection, if it is successful save the changes. |
|
| Finally, move to 'Setup' → 'General Settings' → 'Support'. There choose 'Zendesk' support module form dropdown menu. Save changes. |
|
| 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 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 area, their visibility, sorting etc. |
|
| 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:
|
|
| 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 or type in the number of the color you like. |
|
| Tickets of each status are now marked with selected colors on homepage. |
|
| Below the 'Status Color' you will find a box where you can define what the default department for exported tickets will be. You can choose from your existing Zendesk departments. |
|
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. |
|
| 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. |
|
Export
| Our module allows to export data gathered in your 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 synchronizations. |
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 'Export' button as marked on the screen. |
|
| If a user has already been exported from WHMCS to Zendesk, they will no longer be visible on the list. All users newly added to WHMCS will be automatically synchronized with Zendesk unless otherwise stated in 'Synchronization Settings'. After the successful export you may no longer see your users. To change the view proceed to 'Toggle Filters' to see whether the box defining the view is checked. |
|
| When the box is not checked, you will see the list of users that have been exported. |
|
Tickets
| The next option offered by our module is the export of tickets from WHMCS to Zendesk, proceed to 'Tickets Export'. If you are using Zendesk For WHMCS for the first time, you will see here a list of all tickets which exist in your WHMCS and have not been synchronized with Zendesk yet. |
|
| 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. |
|
| If a ticket has already been exported from WHMCS to Zendesk, they will no longer be visible on the list. All tickets newly created to WHMCS will be automatically synchronized with Zendesk unless otherwise stated in 'Synchronization Settings'. After the successful export you may no longer see your tickets. To change the view proceed to 'Toggle Filters' to see whether the box defining the view is checked. |
|
| When the box is not checked, you will see the list of tickets that have been exported. |
|
Support Tickets
| Move to your Client Area. There, on your homepage, is a 'Recent Support Tickets' box. You will find the latest tickets available in your system. The visible tickets are marked with colors related to their current status. |
|
| 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. |
|
| A new ticket, sent with Zendesk For WHMCS module, is immediately visible in Zendesk admin area. |
|
| Do not hesitate and send a reply to this ticket. |
|
| Client has received an answer. Note that the ticket status has been updated as well. |
|
Tips
| 1. If you create a custom field in Zendesk, it will also be 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. 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. |
|
| Here you can configure the time until when tickets can be reopened by an answer from the client. Maximum possible time is now 672 hours (28 days). |
|
| 4. Attachments are managed in Zendesk, therefore if you do not enable them in Zendesk, your clients will not be allowed to add any in their tickets. To enable attachments in Zendesk please move to 'Zendesk' → 'Settings' → 'Tickets' → 'Attachments'. There enable both options:
|
|
| In case you can see only one option, make sure you have your 'Help Center' active. |
|
| 5. If you would like to use multi 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 enterprise plan. |
|
|
Update Instructions
| Essential guidance through the process of updating the module is offered here. Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price! |
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. |
|