How To Install Helpjuice
Welcome to Helpjuice, this is the first thing you should do.
If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.
- Getting Started
- API V2
- API V3
- Article Editor
- Swifty (In-App Widget)
- Billing / Subscription
Installing Helpjuice is really easy. It takes just a few minutes to connect Helpjuice with your website.
You can use Helpjuice as a widget on your website. All you would need to do is copy-paste this code below anywhere on your website.
Best practice when using iframe code is to put it inside div with some class, so you can position it easier on your website. Embed code is below.
<div id="helpjuice_js_widget_content"> <img src='https://helpjuice.com/images/cube-theme/loading.gif' class="helpjuice-loading-spinner" /> </div> <script> var helpjuice_account_url = "https://YOUR_SUBDOMAIN.helpjuice.com"; </script> <script src="https://s3.amazonaws.com/assets.helpjuice.com/helpjuice.min.js"></script>
The following only applies for 1-page, hash based, apps.
In case you are using a single page application, such as Ember or Angular, it's important to define a variable, where your knowledge base hash is living on.
The Helpjuice_preset_hash This would be the "base" of your helpjuice URL prefix, where Helpjuice is loaded.
For example, if HJ is running on #settings/help, you would type settings/help as the helpjuice_preset_hash value.
<div id="helpjuice_js_widget_content"> <img src='https://helpjuice.com/images/cube-theme/loading.gif' class="helpjuice-loading-spinner" /> </div> <script> var helpjuice_account_url = "https://YOUR_SUBDOMAIN.helpjuice.com"; var helpjuice_preset_hash = ""; </script> <script src="https://s3.amazonaws.com/assets.helpjuice.com/helpjuice.min.js"></script>
Internal articles not appearing, even if I'm logged in another tab
Embedding an <iframe> on your site won't send your session cookies to Helpjuice. The only solution for now is to change your KB to be hosted in a subdomain in your domain. Check this article for more details.