JavaScript ( Web )

Last updated 11 days ago

Here's a guide that can enable you to trigger Airim from any custom link or button from your website/app

Introduction

Airim has a JavaScript API to control its behaviour as you like. Below are functions that Airim supports.

These commands are queued so you don't need to wait for airim to load completely, events will be automatically fired on load in sequence.

airim('widgetOpen') // opens the widget
airim('widgetClose') // closes the widget
airim('widgetHide') // hides the widget and the launcher on the page
airim('widgetShow') // displays the widget on the page

Identify Users

You can use the identify api to map a user on your product to an airim user. Please see the code below

// identifier can be anything like email / username etc but should be unique
// name can be any string
// tags are meant to tag a user like 'new-lead' or 'happy-customer'
airim('identify','<identifier>',{
name: '<name>',
tags: ['tag1','tag2']
})

Callbacks

OnLoad callback

airim('onload', function(){
console.log('airim widget is loaded')
// custom function here
doSomething();
})

Event callbacks are executed when an event like 'Open' or 'Close' takes place . Examples below

airim('on', 'widgetClose', function(){
console.log('airim widget was closed')
// custom function here
doSomething();
})
airim('on', 'widgetOpen', function(){
console.log('airim widget was opened')
// custom function here
doSomething();
})

Custom positioning of the icon

// set the position 40px from bottom right corner
airim('setPosition',{
right: '40px',
bottom: '40px'
})
//set position on the left side
airim('setPosition',{
left: '20px',
bottom: '40px'
})

Subscribe to events

airim('subscribe', function(event){
// event contains a data like
// {
// event_cat_id: 108, --> FAQ category id
// event_message: "Clicked on Question: What is life?",
// event_name: "faq_click", --> name of the event
// event_obj: "FAQ",
// event_obj_id: 66, --> FAQ id
// event_type: "click" ,
// event_value: "What is life?"
// }
myFunction(event)
})

Automatic Reload

If you have a single page application the widget will not be able to detect url changes. To make sure the widget is always updated please call this API when the url is changed.

airim('reload')

Examples

Show Airim when a button is clicked on your UI

// hide airim initially
// you can place this code directly below the airim script
airim('widgetHide')
var button = document.getElementById('my-button-id')
button.addEventListener('click', function(){
airim('widgetShow')
airim('widgetOpen')
})