Difference between revisions of "Kayako"

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:

Log in to your WHMCS Admin Area
Navigate to the Support tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings > Support.
Select Kayako in the Support Module menu to activate the module.
Log in to the administration area of your Kayako system.
Navigate to Settings > LoginShare.
Set Enable external authentication for users to Yes.
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.
Edit the group permissions to use LoginShare for that group at Templates - Groups.
Set Use LoginShare to authenticate users to Yes.
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:

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

@@ Line 1: / Line 1: @@
 <div class="docs-alert-danger">
-<span class="title">Deprecated Functionality</span><br />
+<span class="title">Module Deprecated</span><br />
-This functionality has been removed in WHMCS version 8.0+
+This module is deprecated and is no longer distributed as of WHMCS version 8.0.
 </div>
-Kayako is a leading help desk software, and so for those who need something a little more advanced than the support tools included in WHMCS, we have worked with Kayako to make possible integration between their software and WHMCS.
+Kayako is a leading help desk software that offers advanced support tools.
-==Version 4==
+== Version 4 ==
-With Version 4, the new version of Kayako released in November 2010, we have created a loginshare module which allows your clients to login to Kayako using the same email address and password that they are registered with in your WHMCS system, without needing to re-register in your Kayako system.
+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 ===
-# Login to your WHMCS admin area and navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > [[Support_Tab|Support]]''' or, prior to WHMCS 8.0, '''Setup > General Settings > Support'''.
+To set up LoginShare:
-# Select "Kayako" in the '''Support Module''' dropdown to activate the module.
+# Log in to your WHMCS Admin Area
-# Now login to the administration area of your Kayako system. Navigate to '''Settings > LoginShare'''.
+# 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'''.
-# Change the '''Enable external authentication for users''' option to ''Yes''.
+# Select ''Kayako'' in the '''Support Module''' menu to activate the module.
-# Set the LoginShare URL to the file at http://www.yourdomain.com/whmcs/modules/support/kayako/loginshare.php
+# Log in to the administration area of your Kayako system.
-## Replace ''<nowiki>http://www.yourdomain.com/whmcs/</nowiki>'' with the URL to your WHMCS installation.
+# Navigate to '''Settings > LoginShare'''.
-# Finally edit the Group permissions to use loginshare. This feature is located at under '''Templates - Groups > X''' (where x is the group name). By default there is only one called "default".
+# Set '''Enable external authentication for users''' to ''Yes''.
-# Edit that group and change the '''Use LoginShare to authenticate users''' option to ''Yes''.
+# 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'''.
+# Set '''Use LoginShare to authenticate users''' to ''Yes''.
+# Update the links in the WHMCS Client Area and the header template files to point to the appropriate Kayako system files.
-And that's all there is to it. As a final step, you would then just need to update the links in your custom WHMCS homepage and header template files to point to the Kayako system files.
+=== Third-Party Client Area Integration ===
-===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 [http://forge.kayako.com/projects/aiso-whmcs-integration official addons directory].
-There is also a full client area integration that has been created by a third party. As a result neither ourselves nor Kayako can provide any endorsement or support for it, but it is available and user feedback is generally positive. You can find out more details about it in Kayako's official addons directory:
+== Version 3 ==
- http://forge.kayako.com/projects/aiso-whmcs-integration
+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 ===
-==Version 3==
+You can find instructions to set up this integration in the <tt>/integrate/</tt> folder of the Kayako SupportSuite or eSupport package. If this folder and its files are not present, contact Kayako support.
-For Kayako Version 3, there is a full client area integration which allows the built in support tools to be replaced by the Kayako equivalents for a seamless client area experience. The way this works is by displaying the Kayako content in place of where the WHMCS support content would normally appear.
+After you edit and upload the files in the <tt>readme</tt> file, you will need to activate the integration within WHMCS.
-===Setting up Integration===
+To do this:
+# Log in to the Admin Area.
-To setup this integration, simply take a look at the /integrate/ folder of your Kayako SupportSuite or eSupport download (available from the Kayako members' area) package for the files and instructions.
+# 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.
-If the /integrate/ folder and its files are not present, contact Kayako support and they should be able to provide you with the files you need.
-Once you have edited and uploaded the files as described by the readme document found in the /integrate/ folder, you will need to activate the integration within WHMCS. Simply log into your admin area and go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Support''' or, prior to WHMCS 8.0, '''Setup > General Settings > Support''' and choose '''Kayako''' from the '''Support Module''' dropdown menu.
 __NOTOC__

Documentation