Support Center

Using Helppier API

Last Updated: Jan 05, 2018 03:53PM WET
To configure the API, you can add the following properties to your Snippet Code on the API callback:
 

Segmentation allows you to show different guides for different types of users (first time, regular, etc) by customizing the dimensions or values of any set conditions.

 
  • Segmentation / Dynamic Ids
helppierSegmentation = {userId: userLogedin, gender: “male”}
 
It is possible to show or hide the login menu of your widget.  
  • Show/Hide login
window.helppierShowLogin = false;
 
Choose between showing or hiding the widget’s launcher on your webpage.
  • Show/Hide launcher
window.helppierShowLauncher = false;
 
With Helppier you can change colors and font to match to your website or web app.
  • Launcher Color
window.helppierColorSelector = '.masterBorderColor';
window.helppierColorAtributte = ‘border-color';
 
Languages
 
By default, the widget language displayed is based on the lang property of the HTML tag. If you want to override this functionality, you can define the language through the variable:
  • window.helppierCurrentPageLanguage = "pt"
 
Define the language to which the tutorials’ text will be saved and assigned to:
  • window.defaultLanguage = "pt"

 
The following events are triggered by Helppier

Click Play Next - Triggered whenever a user clicks on the "next" button in the guide or uses the right arrow key.

Click Play Stop - Triggered whenever a user stops a guide by clicking on the "stop" or the close button or uses the "Esc" key.

Click on Tools - Triggered whenever someone selects one of the tools

Click Close - Triggered whenever a user close a guide by clicking on the close button or uses the "Esc" key.

Click Play - Triggered whenever a user starts a guide by clicking on the "play" icon.

Feedback Click - Triggered whenever a user starts a guide and clicks on the feedback button in the bubble.

Click Play Previous - Triggered whenever a user clicks on the "previous" link in the guide or uses the left arrow key.

Click In Love Emote - Triggered whenever a user clicks on the “in love” emote of the feedback.

Click Neutral Emote - Triggered whenever a user starts a guide and clicks on the “neutral” emote of the feedback.

Click Sad Emote - Triggered whenever a user starts a guide and clicks on the “sad” emote of the feedback.

Click Happy Emote - Triggered whenever a user starts a guide and clicks on the “happy“ emote on the feedback.

Click Angry Emote - Triggered whenever a user starts a guide and clicks on the “angry” emote on the feedback.

Click Feedback Message - Triggered whenever a user starts a guide and clicks on the “in love” emote and enters a suggestion.

Click in REC - Triggered whenever a user selects the “Add new guide” and selects the “Record” icon or in the guides list by clicking in the “edit” icon and selects the “Record” icon.

Tutorial Saved - Triggered whenever a user saves a guide by clicking on the "save" icon.






 
019f9d71182f0b622cee9d4050fb5d42@helppier.desk-mail.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete