Getting Started
Welcome to Innkeepr! This doc walks you through each of the tasks to become familiar with Innkeepr.
The guide is broken into two categories of tasks:
Basics: These tasks allow you to send first user data to Innkeepr.
Advanced: These tasks allow you to send additional types of data (track & identify) and give you an introduction on how to enhance your user tracking for advanced audience setups.
Basics
The tasks included help you send event data from your Shop or Web app via Innkeepr.js (a library that sends data to Innkeepr), and use it to create audiences with users most likely to reach your conversion goals.
The Basic tasks include:
Create your Innkeepr URI
Install Innkeepr.js
Connect additional Sources
Create an Audience
Innkeepr URI
Access Your DNS Management Interface: Log in to your domain registrar's website or wherever you manage your DNS records.
Create a CNAME Record: Navigate to the DNS settings and create a new CNAME record.
Hostname/Name: Enter the subdomain you want to use for CDN routing (e.g., innkeepr.x.com).
Value/Points to: Set it to cdn.innkeepr.ai.
Save Changes: Once you've entered the details, save the changes. Note that DNS changes may take some time to propagate across the internet. It typically ranges from a few minutes to 48 hours, depending on your DNS provider.
Install Innkeepr.js
After setting up the CNAME record, log into your Innkeepr workspace and wait for the Innkeepr interface to approve the new URI. This step ensures that our system recognizes and validates your custom CNAME routing.
Go to Sources > Innkeepr.js.
Enter your Innkeepr URI (e.g., "innkeepr.x.com").
Our interface will indicate with a green checkmark if the DNS record has already been propagated correctly.
If approved, copy the Innkeepr.js script and add it to your website either via Google Tagmanager or directly into the
<header>of your website.
Once you’ve added Innkeepr.js as your Website Source, you’re tracking is operational and is ready to send data into Innkeepr. We also prepared some privacy statements ready to use for your data protection and cookie statements.
Add a Source
A Source is a website, database or cloud application which can either send data to Innkeepr or can be populated with Innkeepr audiences. Create a source for each website or app you want to connect.
To add a Source:
Go to Sources > Catalog.
Choose the Source you’d like to add. Note: we'd recommend setting up all sources you'd like to use audiences with.
Enter required information on the source setup page.
Click Save.
Create an Audience
Audiences are the core of our platform. Through it you can start engaging with your most relevant users (or similar ones) across various platforms. After you've installed Innkeepr.js you can use Innkeepr to build custom seed, retargeting and exclusion audiences.
To create an Audience:
Go to Audiences.
Click Create.
Enter a Name.
Select the Source the Audience shall be uploaded to.
Chose a Conversion Goal the Audience will be optimized for.
Select the Audience type.
Select campaigns for initital training data (optional).
Click Create.
Once created, Innkeepr automatically checks if there are enough data points available to provide an AI model for your Audience. Once they are ready, you will be notified via your workspace dashboards and email.
Advanced
Advanced tasks help you to send additional types of data (identify and track calls) to get a clearer picture of who your users are in order to enhance your audiences.
The Advanced tasks include:
Send an Identify call
The Identify call allows you to tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about the user, like their email, name, and address. Sending an Identify call is your first step towards understanding who your users are.
An example of the types of details you might want to learn and track about your users in an Identify call are:
Name
User ID
Email
Address
Company
Lifetime Value
Send a Track call
The Innkeepr Track call allows you to record any actions your users perform, along with any properties that describe the action. Sending a track call is your first step towards understanding what your users are doing.
Each action that a user takes is known as an event. Each event has a name and properties. For example, the User Registered event might have properties like plan or accountType.
Last updated