Karolina: /* Installation */

2026-03-13T13:05:49Z

‎Installation

Gregor: /* Installation */

2024-01-25T10:34:47Z

‎Installation

Karolina: Created page with "
2023-03-30T08:24:38Z

Created page with "<meta name="keywords" content="whmcs widget for zendesk, whmcs zendesk widget configuration, whmcs zendesk widget management, whmcs zendesk widget installation, whmcs zendesk ..."

New page
<meta name="keywords" content="whmcs widget for zendesk, whmcs zendesk widget configuration, whmcs zendesk widget management, whmcs zendesk widget installation, whmcs zendesk widget common problems, about whmcs zendesk widget, whmcs zendesk widget documentation, whmcs zendesk widget faq, whmcs zendesk widget help, whmcs zendesk widget guide , whmcs zendesk widget wiki, whmcs zendesk widget tutorial, whmcs zendesk widget tips, whmcs zendesk widget wiki"></meta>
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The WHMCS Widget For Zendesk."></meta>

=About WHMCS Widget For Zendesk=
{|
|style="padding: 10px 0px 10px 0px;"|'''WHMCS Widget For Zendesk is a free addition which you can easily install in your own Zendesk.''' 
It allows you to see a preview of customers' details, products, domains and due invoices stored in multiple WHMCS instances within the Zendesk admin area.
|}

'''WHMCS Customer Info Features:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ View Profile Details
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ View Ordered Products
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ View Assigned Domains
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ View Due Invoices
|}
'''General Info:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Toggle Display Of Client Contact Info, Products And Due Invoices
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Connects Multiple Zendesk Brands With WHMCS Instances
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports .htaccess Base Authentication
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports Role Restrictions
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Proxy And IP Addresses Whitelist
|}
{|
|style="padding: 0px 0px 30px 30px;"|✔ Logs Unauthorized WHMCS Access Attempts
|}

=Installation=
{|
|style="padding: 10px 0px 0px 0px;"|'''Installation process of this widget is very simple and should not cause many problems. Let's begin!'''
|}
{|
|style="padding: 20px 0px 15px 15px;"|'''1. Download the widget from [https://www.modulesgarden.com/client-area/download/customer_info_app_for_zendesk here] and extract it. You can also install it directly from [https://www.zendesk.com/apps/whmcs/ Zendesk Marketplace].''' 
Inside you will find: 
'''whmcs_customer_info_app.zip''' - actual app you need to install on your Zendesk server. 
'''includes''' - folder that you need to upload onto your WHMCS server, required for successful connection.
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''2. Log in to your Zendesk admin area, go to '' 'Manage' '' under '' 'APPS' '' category and click on '' 'Upload private app' '' button.'''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZA1.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|Note: If you do not see the '' 'Upload private app' '' button, then you most likely have an insufficient plan. Private apps are only available for 'Professional' and 'Enterprise' Zendesk plans. 
In that case try installing app directly from [https://www.zendesk.com/apps/whmcs/ Zendesk Marketplace] but you will still have to manually upload some files to your WHMCS.
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''3. Afterwards enter app name, add previously downloaded '' 'whmcs_customer_info_app.zip' '' file and press '' 'Upload'. '' '''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZA2.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''4. Enter the title, URL to your WHMCS system, secure code, then check the options that interest you the most and finally click on '' 'Install' '' button.''' 
In addition, if your WHMCS is protected by a base authentication, you can enter the username and password for your .htaccess.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZA3.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Note: If you use '[https://support.zendesk.com/hc/en-us/articles/204108983 Zendesk Multibrand]' feature you can also put several addresses in '''brand_name|brand_URL''' format to establish communication with your multiple WHMCS instances. For example: 
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZA3_2.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''5. As it is shown on the screen below, app has been installed correctly.'''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZA4.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''6. Afterwards upload '' 'includes' '' folder, mentioned in the 1st step of this guide, into your main WHMCS directory. 
Files included in the folder are responsible for communication between Zendesk widget and WHMCS data.''' 
Proceed to '' 'your_whmcs/includes/zendesk_app' '' and set '' 'unauthorized_access_attempts.txt' '' file as writable.
''Note: You can obtain from this file the required Zendesk IP addresses.''
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''7. Now, edit '' 'customer_info.php' '' file.''' 
Enter your secure code into '''$widgetSecureCode''' variable and whitelist Zendesk servers IP under '''$widgetIpWhitelist''' variable as presented on the following screen. 
The typical Zendesk IP addresses are:
192.161.144.144
192.161.144.145
192.161.144.146
192.161.144.147
Since version 1.1.0 of the widget you can also provide IP addresses using CIDR method. For example:
*192.161.144.159/26
''Note: Please keep in mind that there are more possible IP addresses, keep track of the Zendesk official documentation with the current list. 
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZA8.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''8. That's all, you have just successfully finished the installation of WHMCS Widget For Zendesk. 
Let's check the details of your WHMCS customer in Zendesk. To do so, press '' 'Apps' '' button when viewing a particular client ticket.'''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZA9.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''9. On the right side of the screen you can see now complete client details, information on products, domains and due invoices.''' 
Additionally, you can quickly get more details about specific customer info with just a single click.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZA10.png]]
|}

=Tips=
{|
|style="padding: 10px 0px 20px 15px;"|1. If you are using proxy the module also supports the ''' 'Proxy IP Header' ''' and ''' 'Trusted Proxies' ''' provided in WHMCS security settings.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZA8_2.png]]
|}

=Common Problems=
{|
|style="padding: 10px 0px 0px 0px;"|WHMCS Problems:
|}
{|
|style="padding: 10px 0px 0px 15px;"|1. '''Wrong IP Address:''' This problem occurs when connection to WHMCS is not authorized.
|}
{|
|style="padding: 0px 0px 10px 30px;"|''Reason:'' IP address of the host, which is trying to connect, is not on the whitelist. 
''Solution:'' Add the IP address to the '' '$widgetIpWhitelist'' ' array at the top of the customer_info.php file. You can find IPs of the recent connection attempts in '' 'unauthorized_access_attempts.txt' '' file (the file needs '' 'write' '' permissions).
|}
{|
|style="padding: 0px 0px 0px 15px;"|2. '''Wrong Secure Code:''' This problem occurs when the secure code is not set properly.
|}
{|
|style="padding: 0px 0px 10px 30px;"|''Reason:'' Secure code set in Zendesk APP is not the same as '' '$widgetSecureCode' '' at the top of the '' 'customer_info.php' '' file. 
''Solution:'' Set the same code in both places.
|}
{|
|style="padding: 0px 0px 0px 15px;"|3. '''Client not found:''' This error occurs when the client is not registered in WHMCS.
|}
{|
|style="padding: 0px 0px 0px 30px;"|''Reason:'' WHMCS cannot find the client's email in the database. 
''Solution:'' Register the client in WHMCS.
|}
{|
|style="padding: 20px 0px 0px 0px;"|Zendesk App Problems:
|}
{|
|style="padding: 10px 0px 0px 15px;"|1. '''Connection Error:''' This problem occurs when Zendesk cannot connect to WHMCS to get the client's details.
|}
{|
|style="padding: 0px 0px 0px 30px;"|''Possible Reasons:'' URL to your WHMCS system is not set properly.
|}
{|
|style="padding: 0px 0px 0px 145px;"|Firewall, .htaccess etc. is blocking access to the '' 'customer_info.php' '' file.
|}
{|
|style="padding: 0px 0px 0px 30px;"|''Solution:'' Check URL set in APP settings.
|}
{|
|style="padding: 0px 0px 30px 85px;"|Allow access to the '' 'customer_info.php' '' file from the outside of the server (you can also try to access the file from your browser).
|}

@@ Line 68: / Line 68: @@
 |}
 {|
-|style="padding: 0px 0px 20px 15px;"|'''4. Enter the title, URL to your WHMCS system, secure code, then check the options that interest you the most and finally click on '' 'Install' '' button.'''<br />
+|style="padding: 0px 0px 20px 15px;"|'''4. Enter the required installation details:
-In addition, if your WHMCS is protected by a base authentication, you can enter the username and password for your .htaccess.
+* '''Title''' - provide any name that will help you identify the widget installation in Zendesk.
 |}
 {|

@@ Line 46: / Line 46: @@
 |}
 {|
-|style="padding: 20px 0px 15px 15px;"|'''1. Download the widget from [https://www.modulesgarden.com/client-area/download/customer_info_app_for_zendesk here] and extract it. You can also install it directly from [https://www.zendesk.com/apps/whmcs/ Zendesk Marketplace].'''<br />
+|style="padding: 20px 0px 15px 15px;"|'''1. Download the widget from [https://www.modulesgarden.com/client-area/download/customer_info_app_for_zendesk here] and extract it. You can also install it directly from [https://www.zendesk.com/marketplace/apps/support/7549/whmcs/ Zendesk Marketplace].'''<br />
 Inside you will find:<br />
 *'''whmcs_customer_info_app.zip''' - actual app you need to install on your Zendesk server.<br />

WHMCS Widget For Zendesk - Revision history

Karolina: /* Installation */

Gregor: /* Installation */