Personal tools
Namespaces

Variants
Actions

Freshdesk For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(API Connection)
(API Connection)
Line 130: Line 130:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|Click on your profile picture that is in the top right corner of the page and go to '' 'Profile settings' '' section.<br/>
 
|style="padding: 0px 0px 15px 15px;"|Click on your profile picture that is in the top right corner of the page and go to '' 'Profile settings' '' section.<br/>
 +
|}
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:F2_81.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:F2_81.png]]

Revision as of 13:15, 2 January 2017

Contents

About Freshdesk For WHMCS

Freshdesk For WHMCS grants your customers the access to use a complex support system solution in your own WHMCS.

With our module your clients will be able to manage Freshdesk tickets as if they were a part of your system.
This product allows you to easily manage all the tickets that are operated by a support system fully synchronized with your Freshdesk account.

  • Features:
✔ Create Contact Automatically After Customer Account Is Generated in WHMCS Database
✔ Create Contact Automatically When Customer Already Exists in WHMCS Database
✔ Update Contact Data Automatically Based On Changes In Customer Profile Data in WHMCS
✔ Attach Files And Urgency To Ticket
✔ List Recent Tickets
✔ Add Reply To Ticket
  • Integration Features:
✔ Single Sign On (SSO) Integration
✔ Export New Tickets To Freshdesk
✔ Export Clients To Freshdesk On Tickets Creation
✔ Synchronize Ticket Responses Between WHMCS And Freshdesk
✔ Transfer Ticket Fields Settings
✔ Transfer Attachments Settings
✔ Convert Markdowns To HTML
  • General Info:
✔ Custom Templates Support
✔ Multi-Language Support
✔ Supports PHP 5.3 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 Freshdesk 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 Freshdesk For WHMCS.
F1.png
2. Upload and extract the module into the main WHMCS directory.

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

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

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

F2 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'.

F2 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 'Freshdesk' and press 'Activate' button.

F2 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.

F2 6.png
7. You have just successfully installed Freshdesk 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 Freshdesk account.

API Connection

Firstly, log in to your Support Portal in order to enable API access.
F2 8.png
Click on your profile picture that is in the top right corner of the page and go to 'Profile settings' section.
F2 81.png

You can find your API key below the 'Change Password' section, on the right side of the page. 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. |}

F2 91.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.
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:F2 10.png
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.

File:F2 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.

F2 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.

F2 14.png
Finally, move to 'Setup' → 'General Settings' → 'Support'.

There choose 'Zendesk' support module form dropdown menu. Save changes.
From now on, your clients will see Zendesk tickets and departments (not WHMCS).

F2 6 1.png
Good job! Now your WHMCS is connected with Zendesk support system.

Management

Tips

1. If you create a custom field in Freshdesk, it will be also visible in WHMCS. Custom fields need to be enabled/visible/editable by the 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 Freshdesk 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 Freshdesk → Business Rules → Automations.
Find there the option and edit it.
File:F16.png
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).
File:F15.png
4. Attachments are managed in Freshdesk, therefore if you do not enable them in Freshdesk, your clients will not be allowed to add any in their tickets.

To enable attachments in Freshdesk please move to 'Freshdesk' → 'Settings' → 'Tickets' → 'Attachments'. There enable both options:

  • Customers can attach files
  • Require authentication to download
File:F17.png
In case you can see only one option, make sure you have your 'Help Center' active.
File:F18.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 Freshdesk, but it's not verified yet.

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

F14.png
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Freshdesk For WHMCS