API

Checking if the library is loaded

Depending on how the library is included, it may be necessary for you to check if the library is available before performing any actions with it.

Listening for the library announcement

The Lucep library will announce it is available by firing the event lucep-library-ready on the document, so it is possible to create an event listener for this:

document.addEventListener("lucep-library-ready", function(){ 
      //the library is ready, do something here 
}, false);

Checking for object existance

Checking if $lucep is available as an object is a simple and effective way to validate the library is available for use

if ($lucep) {
     //the library is available, do something
}

A combined approach to work with the library

A reliable way to work with the library is to combine these two ways of checking for the availability of the library:

if ($lucep){
     //launch your custom event
 } else {
     document.addEventListener("lucep-library-ready", function(){ 
      //the library is ready, do something here 
}, false);

Initialising the library

The Lucep library requires to be initialised before it can be used, and it can be initialised by providing only the account name with which it should be used.

$lucep.init( { domain: YOUR-DOMAIN-HERE } );

The init function can be called repeatedly without any adverse impact, as only the first call is processed.

Once the init method is fired, all of the other library methods can be used. It is recommended that the init function is fired as early as possible as this will prevent long waiting times for other functions to complete.

$lucep.init ( params )

This method can be invoked multiple times – however only the variables passed in the first call are considered. All other subsequent calls are ignored.

params should be a JavaScript object with the following properties:

$lucep.raise_lead ( params )

Immediately raises a lead to the appropriate team based on the service_id supplied. Notifications are pushed directly to the relevant users as defined in the Lucep console.

{
 "e-mail":  "[email protected]",
 "Home town":  "London" 
}

false - see
$lucep.get_ticket_status
for more info : 
function (resp){ … }

$lucep.send_intelligence ( params )

Sending intelligence instructs the server to maintain a record of a specific significant event with this particular customer. This event is communicated to the sales person when a lead is raised by user in question. This could be anything from a customer scrolling past a particular point on a page, to the customer viewing a specific image. The general guidance is to send events that will be relevant, and helpful, the person that is going to be reviewing the lead ahead of engaging with the customer.

NOTE: It is important to recognise that personally identifiable information should not be sent as data in this method

params should be a JavaScript object with the following properties:

{
 "your-property": "your information"
} 
(no default)

$lucep.put_data ( params )

This method stores data in the browser for retrieval between sessions. It allows for custom identifiers or references to be placed within browser storage using your custom key references. The library will detect if the browser supports WebStorage^[1][2] and use that if available, else it will fall back to Cookies.

This method can be called any number of times, it does not return any data. If the method is called multiple times with the same key, it will overwrite the data stored by the previous call.

params should be a JavaScript object with the following properties:

{
 "your-property":"your property details"
} 
(no default) 

$lucep.get_data ( params )

This method retrieves data that has been stored using $lucep.put_data method. It returns the value associated with the key as a result of the function call.

params should be a JavaScript object with the following properties:

The method will then return the value string that was previously associated with the key (if any)

{ 
 "dom-property-id": {
  "label": "User friendly label",
  "type":"text/checkbox/dropdown",
  "help_txt": "Any applicable help text (optional)",
  "options": [{"option1-id":"Option 1 User Text"}] 
 }
}