Introduction

Webstores that use Agent Inbox (formerly ROBIN) need to place the Agent Inbox script on their site(s). This is done by placing a URL on all pages the website contains. The script that needs to be placed can be obtained in Agent Inbox by navigating to: Settings > Contact tab. This script is of the form:

<script src="https://selfservice.robinhq.com/external/robin/<apikey>.js" async="async"></script>

Where is replaced by the API key of the subscription. When this script is placed, all pages a shopper visits shows a tab. All behavior (labels, content, color and position) of the tab can be configured in the Agent Inbox app . However, sometimes specific functionality is required on the page. When this is the case, the Agent Inbox Javascript API can be used.

Override default behavior

When the Agent Inbox script is loaded, it checks for the existence of a property named robin_settings on the current page (window scope). When such a property exists, its values are combined with the properties of the values that are configured in the Agent Inbox app. All properties that exist in the robin_settings object have a higher priority, hence the configured properties can be overruled. So, for instance it is possible to hide a tab on a specific page.

Overview of overridable options

Events

When the Agent Inbox script is loaded, the init-method is called automatically. This script initializes the tab according to settings specified in the Agent Inbox app (and possibly overruled by specifying a robin_settings object). The init-method also invokes events when can be specified in the robin_settings objects object. Using these events, additional steps can be performed. An example of such a step is display information regarding online employees. Specifying an event handler is done by defining it in the robin_settings object object as follows:

robin_settings = {
	callback: function(event, data){
		if (event == 'init'){
			// specify initialization code here
		}
	}
}

Retrieve information

When the Agent Inbox script is loaded, or when the callback method is invoked, it is possible to access methods available on the Agent Inbox javascript API. Methods that retrieve information, are the following:

Retrieval methods

Invoke methods

When a custom tab is required on a page, it is possible to create an HTML element instead of the Agent Inbox tab (make sure to hide the Agent Inbox tab using robin_settings.hide_tab = true). The click event on the HTML element needs to activate the Agent Inbox contact form. This and other things can be done by invoking methods on the Agent Inbox Javascript API. The Supported methods are the following:

Invoke methods overview

Examples

Behavior can be changed to modify properties. There are a lot of properties to be changed, it is recommended to set a breakpoint and examine the webstore object that is retrieved and look for the property that needs to be changed.

Autofill customers information

Using the following code it is possible to specify the shopper name and email address in case he is logged in, and making the conversation ‘anonymous’ (so the shopper does not have to enter his name).

var robin_settings = {
	callback: function(event, data) {
		if (event == 'init'){
			var name = 'name';		// determine real name
			var email = '[email protected]';	// determine real email

			if (email != null && email != '') {
				var ws = __robin.getWebStore();
				ws.conversationTemplate.useAnonymousChat = true;
				__robin.setShopper(email, name);
			}
		}
	}
};	

Get the list of online user

If you want to create your own tab with online presence from the right agents, you can use the example below.

var robin_settings = {
    callback: function(event, data) {
        if (event == 'init') {
            var onlineUsers = [];
            var users = __robin.getWebStoreUsers();
            for (var i = 0; i < users.length; i++) {
                if (users[i].actualPresence == 'online') {
                    onlineUsers.push(users[i]);
                }
            }
            if (onlineUsers.length >= 1) {
                var d = document.getElementById("robin_tab");
                d.className += " robin-online";
            }
        }
    }
};

Disable Google Analytics

If you don't want to receive the Google Analytics events from our widget, you can use the following script.

var robin_settings = {
    callback: function(event, data) {
        if (event == 'init') {
            var oldtracker = ga.getAll()[0];
            var tracker = {
                set: function(a, b) {
                    oldtracker.set(a, b);
                },
                send: function(a, b, c, d) {
                    if (b !== 'ROBIN-PAGES' && b !== 'ROBIN-TAB') {
                        oldtracker.send(a, b, c, d);
                    }
                }
            };
            ga.getAll = function() {
                return [
                    tracker
                ];
            }
        }
    }
};