A Basic Installation

This guide walks you through setting up Innkeepr on your site by configuring DNS and creating an Innkeepr.js source.

Step 1: Setup DNS

Access your DNS Management: Log in to your domain's DNS management interface.
Create an Innkeepr URI: Add a CNAME record pointing to cdn.innkeepr.ai. This allows your site to communicate with Innkeepr servers.
Wait for Propagation: It may take some time for the new DNS record to propagate. Check the status after a few minutes.

Step 2: Create an Innkeepr.js Source

Navigate to Sources.
Click Add Source.
From the source catalog page, select JavaScript.
Insert your Innkeepr URI.
Paste this snippet into the <head> tag of your site or a custom HTML tag of your Tag Manager.

<script type="text/javascript">
  (function () {
    if (window.Innkeepr && Object.keys(window.Innkeepr).includes('load')) {
      // Now we assume Innkeepr is already loaded
      console.warn('Detected attempt to load Innkeepr multiple times.');
      return;
    }
    var innkeepr = (window.Innkeepr = []);

    innkeepr.methods = ['identify', 'track', 'getCookie'];

    innkeepr.factory = function (method) {
      return function () {
        var args = Array.prototype.slice.call(arguments);
        args.unshift(method);
        innkeepr.push(args);
        return innkeepr;
      };
    };

    for (var i = 0; i < innkeepr.methods.length; i++) {
      var key = innkeepr.methods[i];
      innkeepr[key] = innkeepr.factory(key);
    }

    innkeepr.load = function (apiKey, apiUrl) {
      // Create an async script element based on your key.
      innkeepr.apiKey = apiKey;
      innkeepr.apiUrl = apiUrl
      var script = document.createElement('script');
      script.type = 'application/javascript';
      script.async = true;
      script.src = 'YOUR_INNKEEPR_URI';

      var first = document.getElementsByTagName('script')[0];
      first.parentNode.insertBefore(script, first);
    };

    innkeepr.SNIPPET_VERSION = '1.1.0';
    
    // Load Innkeepr.js with your key
    innkeepr.load('YOUR_API_KEY', 'https://api.innkeepr.ai');
  })();
</script>

Step 3: Identify Users

The identify method is how you tell Innkeepr who the current user is. It includes a unique User ID and optional traits you know about them. You can read more about it in the identify method reference.

Note: You don’t need to call identify if you have a shop system connected with Innkeepr. We automatically assign an anonymousId as well as other User IDs.

Here’s an example of what a basic call to identify might look like:

Innkeepr.identify('f4ca124298', {
  name: 'Michael Brown',
  email: 'mbrown@example.com'
});

This identifies Michael by his unique User ID (in this case, f4ca124298, which is what you know him by in your database) and labels him with name and email traits. When you put that code on your site, you need to replace those hard-coded trait values with the variables that represent the details of the currently logged-in user.

Step 4: Track Events

The track method is how you tell Innkeepr about events users perform on your site. Every action triggers what Innkeepr calls an “event”, which can also have associated properties. You can read more about track in the track method reference. Here’s an example of what a call to track might look like when a user signs up:

Innkeepr.track('Checkout completed', {
  revenue: 10.99
});

This example shows that your user triggered the Checkout Completed event and checked out with 10.99 in revenue. Properties can be anything you want to record, for example:

Innkeepr.track('Product Viewed', {
  id: 'c6ca124228',
  category: 'shoes',
  price: 20.99
});

If you’re just getting started, some of the events you should track are events that indicate the success of your site, like Signed Up, Item Purchased or Article Bookmarked. Innkeepr recommends that you track a few important events as you can always add more later. Once you add a few track calls, you’re done with setting up Innkeepr. You successfully installed Innkeepr.js tracking. Now you’re ready to create your first Audiences.

PreviousGetting Started Guide NextServer-Side Installation

Last updated 5 months ago