The Cliengo API

Welcome to the Cliengo developer hub. You'll find comprehensive guides and documentation to help you start working with Cliengo as quickly as possible, as well as support if you get stuck. Let's jump right in!

API Reference    Get Started

Getting started with the Javascript API

Our documentation to help you customize Leadaki to fit your website

We offer a Javascript API that gives you flexibility and control over the behavior of the Cliengo chatbot, conversion pixels, submit forms, etc. You can decide, how, when and where to display the chatbot on your site, or disable/enabled some features in your website specific pages.

For using Leadaki Javascript API:

  • Make sure you have installed the latest Leadaki Installation code in your website.
  • For specific settings, place leadakiSettings in your webpage before Cliengo Installation code.

Installation

Your Cliengo Installation Code is a javascript similar to this:

<!-- Cliengo Installation Code -->
<script type="text/javascript">
(function(){
  var ldk=document.createElement('script'); 
  ldk.type='text/javascript'; 
  ldk.async=true;
 ldk.src='https://s.cliengo.com/weboptimizer/{companyId}/{websiteId}.js';
  var s=document.getElementsByTagName('script')[0];
  s.parentNode.insertBefore(ldk, s);})();
</script>

Configuration

For specific settings in your webpage, you have to set leadakiSettings object before the Installation Script. See more details

<script>
/* custom configuration goes here (developers.cliengo.com/docs/javascript-api) */  
window.leadakiSettings = {someConfig:'value'}
</script>

We encourage developers to write their own JavaScript to extend the Cliengo functionality on their websites. We're very excited when we see examples of the API used in creative ways. Let us know if you have an interesting implementation and we may publish it.

Support

If you have a problem with an API call, such as it not returning the correct value or not performing the intended action, email support@cliengo.com with a link to a page where we can test the functionality and information about the steps that you've taken to debug so far.

Testing and Debugging

The API is intended to be self-serve. Although we can't debug or write JavaScript for you, there are some helpful ways to test your own code during development:

Debugging

<script>
/* Use this configuration for enable Cliengo debug to console.log()  */  
window.leadakiSettings = {debug:true}
</script>

Or you can set on any part of your code (after beeing loaded)

Leadaki.debug = true 

Learning JavaScript

If you're new to JavaScript entirely, you might want to start with one of these Online Javascript courses: Codecademy, Code School and Treehouse

Getting started with the Javascript API


Our documentation to help you customize Leadaki to fit your website

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.