Installing the HelpShelf widget

Once you've setup your site, you'll then need to install the widget on your site. To do this, simple paste the code below in the header of your website, just before the closing </head> tag.

<script type="text/javascript" id="hs-loader">

window.helpShelfSettings = {
"siteKey": "SITE_ID",
"userId": "",
"userEmail": "",
"userHash": ""
};
(function() {var po = document.createElement("script"); po.type = "text/javascript"; po.async = true;
po.src = "https://s3.amazonaws.com/helpshelf-production/gen/loader/SITE_ID.min.js";
po.onload = po.onreadystatechange = function() {var rs = this.readyState; if (rs && rs != 'complete' && rs != 'loaded') return;HelpShelfLoader = new HelpShelfLoaderClass(); HelpShelfLoader.identify(window.helpShelfSettings);};
var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(po, s);})();
</script>

Note: You must remember to change the SITE_ID placeholders (there are two) above with your site ID. Your unique HelpShelf script, complete with the site ID's already added can be found in the Setup page when logged into your HelpShelf account. We recommend that you copy the code from there, to ensure the Site ID is inserted correctly. The above should be used just for reference.

Tracking users

If you want to track logged in users (which is required by most of the Helpdesk providers (such as Intercom) you might want to connect to HelpShelf) then you will need to add values to the userID. userEmail and userHash fields shown above in the script reference. If you are not a developer, this is the part where you will probably need to get your developer involved.

Have you removed your previous help desk scripts?

This is a super important step. If you are linking Intercom (for example) to your HelpShelf widget, so that your users can contact you via that platform, then you must remember to first remove the existing Intercom script from your site (if there is one). Otherwise, your users will see the Intercom widget AND the HelpShelf one at the same time - which is going to look weird and will ultimately confuse your users.


How did we do?


Powered by HelpDocs

Powered by HelpDocs