Hushly Javascript API Reference

Modified on Thu, 26 Oct 2023 at 02:20 AM

Event Handling

Hushly JavaScript Events API adds the capability to trigger functions on certain states of Hushly, providing the tools needed to further extend Hushly to suit your specific needs. 


Usage:

hushly('bind', EVENT-NAME, function(event) {
 // event handling code.
});


ParameterOptional/RequiredTypeDescription
methodRequiredString    Method Name        
eventNameRequiredStringName of the Event
function_to_triggerRequiredFunctionFunction to Trigger on Event


event object will contain information about the Hushly event. Check the event documentation below to find the attributes available in the event object.

Example: Publishing a custom event to Google Analytics when content is viewed via Hushly Experience.

// use hushly event handler to publish a custom event to google analytics.
hushly('bind', 'content-view', function(event) {
ga('send', 'event', {
'eventCategory': 'Hushly Experience',
'eventAction': 'Content View',
'eventLabel': event.experienceName
});
});


Configuring the Event Handlers


Follow the steps below to configure Event handlers directly in Hushly.

  • Navigate to Setup > Settings
  • Scroll to the Tracking section, Configure the event handlers in the Event Handlers field
  • Event handlers can be appended by clicking on the available event names below the field.


Events

Events are user interactions with content that can be measured independently from a web page or screen load. Downloads, link clicks, form submissions, scroll or video plays are all examples of actions you might want to analyze as Events.

Before Experience Trigger Activate: before-trigger-activate

Fired before the Experience Trigger is activated, This event is fired only when the user is interacting with Experiences.

hushly('bind', 'before-trigger-activate', function(event) {
// your integration code for before-trigger-activate event
});


Attribute DescriptionExperienceHub
assetIdId of the Asset the user is interacting with

assetNameName of the Asset the user is interacting with

experienceIdId of the Experience the user is interacting with

experienceNameName of the Experience the user is interacting with

triggerTypeType of Trigger (ExitIntent/Click...)

contentRuleId(Optional) Id of the Content Personalization Rule


Content View: content-view

Fired after the Hushly Experience is popped or the Stream Content Page is viewed.

hushly('bind', 'content-view', function(event) {
// your integration code for content view
});


Attribute DescriptionExperienceHubABM Page
assetIdId of the Asset the user is interacting with
assetNameName of the Asset the user is interacting with
assetTypeAsset Type the user is interacting with
experienceIdId of the Experience the user is interacting with


experienceNameName of the Experience the user is interacting with


streamIdId of the Stream the user is Interacting with
streamNameName of the Stream the user is interacting with
triggerTypeType of Trigger (ExitIntent/Click...)


contentRuleId(Optional) Id of the Content Personalization Rule


visitorABM Visitor accessing the Page

accountABM Account

pageABM Page


Content Interaction: content-interaction

Fired when a user interacts with the content like scrolling the pages or clicking the Play button for video-type content

hushly('bind', 'content-interaction', function(event) {
// your integration code for content-interaction event
});


Attribute DescriptionExperienceHubABM Page
assetIdId of the Asset the user is interacting with
assetNameName of the Asset the user is interacting with
assetTypeAsset Type the user is interacting with
experienceIdId of the Experience the user is interacting with


experienceNameName of the Experience the user is interacting with


streamIdId of the Stream the user is Interacting with
streamNameName of the Stream the user is interacting with
triggerTypeType of Trigger (ExitIntent/Click...)


contentRuleId(Optional) Id of the Content Personalization Rule


categoryType of the Asset (video/pageFlip/toolbarAction)
typeType of Interaction

Toolbar Actions (Common for Documents and Videos)
  • downloadClick 
  • maximize
For Document Type Assets
  • flipPrevious
  • flipNext
For Video Type Assets
  • videoPlay
  • videoPause
  • videoEnd
pageNumberPage Number of the Document (Only for Document
type Assets)
visitorABM Visitor accessing the Page

accountABM Account

pageABM Page


 


Recommendation Open: recommendation-open

When a user selects content in the Recommendation section by clicking on it and views the Content Page.

hushly('bind', 'recommendation-open', function(options) {
// your integration code for recommendation-open event 
});


Attribute DescriptionExperienceHubABM Page
assetIdId of the Asset the user is interacting with

assetNameName of the Asset the user is interacting with

assetTypeAsset Type the user is interacting with

 
experienceIdId of the Experience the user is interacting with


experienceNameName of the Experience the user is interacting with


streamIdId of the Stream the user is Interacting with

streamNameName of the Stream the user is interacting with

triggerTypeType of Trigger (ExitIntent/Click...)


contentRuleId(Optional) Id of the Content Personalization Rule


visitorABM Visitor accessing the Page


accountABM Account


pageABM Page



Form View: form-view

Fired when a user views the Hushly Form in an Experience or Stream Item Page

hushly('bind', 'form-view', function(options) {
// your integration code for form-view event
});


Attribute DescriptionExperienceHub
ABM Page
assetIdId of the Asset the user is interacting with

assetNameName of the Asset the user is interacting with

assetTypeAsset Type the user is interacting with
 
experienceIdId of the Experience the user is interacting with


experienceNameName of the Experience the user is interacting with


streamIdId of the Stream the user is Interacting with

streamNameName of the Stream the user is interacting with

triggerTypeType of Trigger (ExitIntent/Click...)


contentRuleId(Optional) Id of the Content Personalization Rule


emailEmail Address that the user submitted

countryCountry selected by the user in Hushly Form

pageUrlURL of the Page where the user Submitted the Form

referrerReferrer URL of the Page

visitorABM Visitor accessing the Page


accountABM Account


pageABM Page



Invalid Form Submit: invalid-form-submit

Fires when a form submission is failed. Eg. when a user submits a non-business email address or a role email address.

hushly('bind', 'invalid-form-submit', function(event) {
// your integration code for invalid form submit event
});


Attribute DescriptionExperienceHub
ABM Page
assetIdId of the Asset the user is interacting with

assetNameName of the Asset the user is interacting with

assetTypeAsset Type the user is interacting with

experienceIdId of the Experience the user is interacting with


experienceNameName of the Experience the user is interacting with


streamIdId of the Stream the user is Interacting with

streamNameName of the Stream the user is interacting with

triggerTypeType of Trigger (ExitIntent/Click...)


contentRuleId(Optional) Id of the Content Personalization Rule


emailEmail Address that the user submitted

countryCountry selected by the user in Hushly Form

pageUrlURL of the Page where the user Submitted the Form

referrerReferrer URL of the Page

visitorABM Visitor accessing the Page


accountABM Account


pageABM Page



Valid Form Submit: form-submit

Fired when a user successfully submits a Hushly Form in an Experience or Stream Item Page

hushly('bind', 'form-submit', function(event) {
// your integration code for form-submit event
});


Attribute DescriptionExperienceHub
ABM Page
assetIdId of the Asset the user is interacting with

assetNameName of the Asset the user is interacting with

assetTypeAsset Type the user is interacting with

experienceIdId of the Experience the user is interacting with


experienceNameName of the Experience the user is interacting with


streamIdId of the Stream the user is Interacting with

streamNameName of the Stream the user is interacting with

triggerTypeType of Trigger (ExitIntent/Click...)


contentRuleId(Optional) Id of the Content Personalization Rule


emailEmail Address that the user submitted

countryThe country selected by the user in Hushly Form

pageUrlURL of the Page where the user Submitted the Form

referrerReferrer URL of the Page

visitorABM Visitor accessing the Page


accountABM Account


pageABM Page



Experience Close: experience-close

Fired when the Experience is closed, This event is fired when the user closes the Experience.

hushly('bind', 'experience-close', function(options) {
// your integration code for experience-close event
});
JavaScript


Attribute DescriptionExperienceHub
assetIdId of the Asset the user is interacting with

assetNameName of the Asset the user is interacting with

experienceIdId of the Experience the user is interacting with

experienceNameName of the Experience the user is interacting with

triggerTypeType of Trigger (ExitIntent/Click...)

contentRuleId(Optional) Id of the Content Personalization Rule


Anonymous Download: anonymous-download

Fired when the user anonymously downloads an Asset at the Experience or Stream level.

hushly('bind', 'anonymous-download', function(options) {
// your integration code for anonymous-download event
});


Attribute DescriptionExperienceHub
ABM Page
assetIdId of the Asset the user is interacting with

assetNameName of the Asset the user is interacting with

experienceIdId of the Experience the user is interacting with


experienceNameName of the Experience the user is interacting with


widgetIdId of the Widget the user is interacting


contentRuleId(Optional) Id of the Content Personalization Rule


visitorABM Visitor accessing the Page


accountABM Account


pageABM Page



Search: search 

Fired when the user performs a search in the Hub.

hushly('bind', 'search', function(options) {
// your integration code for search event
});


Attribute DescriptionExperienceHub
query 

The search query is entered by the user.


filtersV2Hub Only - The filters selected by the user in a JSON format.
{
"industries": [
"Healthcare",
"Management"
],
"topics": [
"Customer Success",
"Cloud"
]
}






ABM CTA Click: abm-cta-click

Fired when the user clicks on the CTA Button.  

hushly('bind', 'abm-cta-click', function(options) {
// your integration code for abm-cta-click event
});


Attribute Description
ABM Page
visitor
ABM Visitor accessing the Page

account
ABM Account

page
ABM Page



Disable Exit Intent Trigger


Disables the Exit Intent Triggers for all the Experiences on the Page.


Usage:

hushly('disableExitIntentTriggers')




Exclude Forms from Form Submission Tracking


All the form submissions on the landing page are being tracked, sometimes this may not provide accurate information to the customers, as there can be other forms on the same landing page like search forms, chatbot forms, etc.  


To exclude some forms from being tracked.


Usage:

hushly('excludeForms', 'form1, form2');




Publish an event to activate an Experience


When setting up an experience you have the option of using javascript event triggers. This means you can have your experience triggered by any custom event on your website. This can be when your visitor clicks a button or comes from a certain source - or any other event you need.


To trigger an experience, you need to call a Hushly function.

 

Usage:

hushly("event", "my-event-name");



Common Use Cases


Trigger an experience when clicking an element

To trigger an experience on a click, you first need to create a click handler for the element that should be clicked. In this example, we'll have the user click a button:

<button id="download-content" type="button">Download Whitepaper</button>

Using the ID of this button, we can easily create a click handler: 

$('#download-content').click( function() {
hushly('event', 'download-white-paper');
});


That's it. The experience will now be triggered when the button is clicked.


Trigger a campaign for specific referrers

Triggering an experience for certain referrers can be useful if you want to target visitors from a certain source. In this example, we'll target all visitors from google.com. First, we'll use the referrer property in JavaScript:


This property will return a string containing the URL of the referral page. If that page was google.com, the string could look like this: 


We can then use JavaScript to look at the value of this property for each visitor - and to trigger the Feedback campaign if the string contains a certain value. In this case, we'll look for the value 'google.com': 

if (document.referrer.indexOf('google.com') > -1) {
hushly('event', 'download-white-paper');
}




Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article