Terminology

Lead

A lead stands for a visitor on your website who started a chat with your company. Cheerlink automatically generate a random name based on their location for a lead (e.g. Blue Squirrel from Pittsburgh).

Customer

When you know who your users are when they chat or use your product, you can identify them as customers (e.g. when they are logged in).

Installing Cheerlink for Leads

1. Copy and paste this code snippet before the </body> tag on every page you want the Widget to appear. Change the APP_ID to your workspace id.
2. Once you’ve completed your changes, open your website. Cheerlink Widget should appear in the bottom right corner.

<script>
//Set your APP_ID
window.cheerlinkSettings = {
    appId: "APP_ID",
};
</script>

<script>
!function(){var e=window,t=document,a=function(){var e=t.createElement("script");e.type="text/javascript",e.async=!0,e.src="<https://static.cheerlinkapp.com/sdk/pure/entry/cheerlinkSeed.js>";var a=t.getElementsByTagName("script")[0];a.parentNode.insertBefore(e,a)};"complete"===document.readyState?a():e.attachEvent?e.attachEvent("onload",a):e.addEventListener("load",a,!1)}();
</script>

Install Cheerlink for Logged-in Customers

• You can identify customers with a customer ID or email address.
• If you send both a customer ID and an email address, the customer ID will take priority.

<script>
//Set your APP_ID
window.cheerlinkSettings = {
    appId: "APP_ID",
    user: {
      bizUserId: user.id, // User id,
      email: user.email // Email address
    }
};
</script>

<script>
!function(){var e=window,t=document,a=function(){var e=t.createElement("script");e.type="text/javascript",e.async=!0,e.src="<https://static.cheerlinkapp.com/sdk/pure/entry/cheerlinkSeed.js>";var a=t.getElementsByTagName("script")[0];a.parentNode.insertBefore(e,a)};"complete"===document.readyState?a():e.attachEvent?e.attachEvent("onload",a):e.addEventListener("load",a,!1)}();
</script>

If installed correctly, your Widget will send this kind of user data to Cheerlink:

id: "john_doe"
name: "John Doe",
email: "[email protected]"