Installation

We want the installation to be a piece of cake so you can start using UserEngage faster than you think! There are just a few easy steps:

  1. Sign up for a free trial.
  2. Use one of the plug-ins and add-ons to automatically integrate the most popular CMSes and frameworks with UserEngage. Here you can find the list of all plugins and integrations with information on installation.
    Insert the JavaScript code. Choose a snippet to copy (for logged-out visitors and logged-in with user data) and paste it before the </body> tag into your website source code.

Logged Out

<script data-cfasync="false" type="text/javascript">
  window.civchat = {
    apiKey: 'YOUR_API_KEY'
  }
</script>
<script data-cfasync="false" type="text/javascript" src="https://widget.userengage.io/widget.js"></script>

Logged In

<script data-cfasync="false" type="text/javascript">
  window.civchat = {
    apiKey: 'YOUR_API_KEY',
    name: "John Doe",
    email: "[email protected]",
    gender: 2,
    status: 2,
    phone_number: "+48754123434", // Must be a valid E.164 format
    first_seen: "2016-11-22T11:47:40.957983Z", // Must be a valid ISO 8601 format
    last_seen: "2016-11-22T11:47:40.960405Z", // Must be a valid ISO 8601 format
    page_views: 1,
    last_ip: "84.10.12.178",
    timezone: "America/Los_Angeles",
    city: "Montebello",
    country: "United States",
    emails_enabled: true,
    browser_language: "en",
    score: 0,
    browser: "Chrome",
    os_type: "Windows",
    resolution: "1373x933",
    notifications: true,
    company: {
      revenue: "$239.9 billion",
      employees: 32
    }
  }
</script>
<script data-cfasync="false" type="text/javascript" src="https://widget.userengage.io/widget.js"></script>

Optional settings

<script data-cfasync="false" type="text/javascript">
  window.civchat = {
    state: "hidden" // Hide the chat widget
  }
</script>
<script data-cfasync="false" type="text/javascript" src="https://widget.userengage.io/widget.js"></script>