Difference between revisions of "Kayako"

From WHMCS Documentation

(Third-Party Client Area Integration)
(Setting Up Integration)
 
(2 intermediate revisions by the same user not shown)
Line 8: Line 8:
 
== Version 4 ==
 
== Version 4 ==
  
With Version 4, the new version of Kayako released in November 2010, we have created a LoginShare module that allows your clients to log in to Kayako using their WHMCS email address and password without needing to re-register in Kayako.
+
The LoginShare module for Kayako allows your clients to log in to Kayako using their WHMCS email address and password, without needing to re-register in Kayako.
  
 
=== Setting up LoginShare ===
 
=== Setting up LoginShare ===
  
 +
To set up LoginShare:
 
# Log in to your WHMCS Admin Area
 
# Log in to your WHMCS Admin Area
 
# Navigate to the '''[[Support_Tab|Support]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings > Support'''.
 
# Navigate to the '''[[Support_Tab|Support]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings > Support'''.
Line 18: Line 19:
 
# Navigate to '''Settings > LoginShare'''.
 
# Navigate to '''Settings > LoginShare'''.
 
# Set '''Enable external authentication for users''' to ''Yes''.
 
# Set '''Enable external authentication for users''' to ''Yes''.
# Set the LoginShare URL to the file at <tt><nowiki>http://www.yourdomain.com/whmcs/modules/support/kayako/loginshare.php</nowiki></tt>, replacing <tt><nowiki>http://www.yourdomain.com/whmcs/</nowiki></tt> with the URL to your WHMCS installation.
+
# Set the LoginShare URL to the file at <tt><nowiki>http://www.example.com/whmcs/modules/support/kayako/loginshare.php</nowiki></tt>, replacing <tt><nowiki>http://www.example.com/whmcs/</nowiki></tt> with the URL to your WHMCS installation.
 
# Edit the group permissions to use LoginShare for that group at '''Templates - Groups'''.
 
# Edit the group permissions to use LoginShare for that group at '''Templates - Groups'''.
 
# Set '''Use LoginShare to authenticate users''' to ''Yes''.
 
# Set '''Use LoginShare to authenticate users''' to ''Yes''.
Line 39: Line 40:
 
To do this:
 
To do this:
 
# Log in to the Admin Area.
 
# Log in to the Admin Area.
# Go to the '''Support''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings > Support'''.
+
# Go to the '''[[Support Tab|Support]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
 
# Select '''Kayako''' from the '''Support Module''' menu.
 
# Select '''Kayako''' from the '''Support Module''' menu.
  
 
__NOTOC__
 
__NOTOC__

Latest revision as of 19:50, 25 April 2022

Module Deprecated
This module is deprecated and is no longer distributed as of WHMCS version 8.0.

Kayako is a leading help desk software that offers advanced support tools.

Version 4

The LoginShare module for Kayako allows your clients to log in to Kayako using their WHMCS email address and password, without needing to re-register in Kayako.

Setting up LoginShare

To set up LoginShare:

  1. Log in to your WHMCS Admin Area
  2. Navigate to the Support tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings > Support.
  3. Select Kayako in the Support Module menu to activate the module.
  4. Log in to the administration area of your Kayako system.
  5. Navigate to Settings > LoginShare.
  6. Set Enable external authentication for users to Yes.
  7. Set the LoginShare URL to the file at http://www.example.com/whmcs/modules/support/kayako/loginshare.php, replacing http://www.example.com/whmcs/ with the URL to your WHMCS installation.
  8. Edit the group permissions to use LoginShare for that group at Templates - Groups.
  9. Set Use LoginShare to authenticate users to Yes.
  10. Update the links in the WHMCS Client Area and the header template files to point to the appropriate Kayako system files.

Third-Party Client Area Integration

There is also a full third-party Client Area integration. It is unsupported but is available for use. You can find out more details about it in Kayako's official addons directory.

Version 3

For Kayako version 3, there is a full Client Area integration that allows you to replace WHMCS's built-in support tools with the Kayako equivalents. This displays the Kayako content where the WHMCS support content would normally appear.

Setting Up Integration

You can find instructions to set up this integration in the /integrate/ folder of the Kayako SupportSuite or eSupport package. If this folder and its files are not present, contact Kayako support.

After you edit and upload the files in the readme file, you will need to activate the integration within WHMCS.

To do this:

  1. Log in to the Admin Area.
  2. Go to the Support tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.
  3. Select Kayako from the Support Module menu.