Our documentation - for the time being.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md
gtm-walkthrough.gif
html-walkthrough.gif
shopify-walkthrough.gif
squarespace-walkthrough.gif
tumblr-walkthrough.gif
weebly-walkthrough.gif
wordpress-walkthrough.gif

README.md

UserPath Documentation

Our documentation - for the time being. If you have any questions, please don't hesitate to email support@userpath.co - we will get back to you as quickly as possible!

Plugin Installation Instructions

These instructions guide you through setup for our most common platforms as well as plain HTML setup. If we're missing a platform, please email us at support@userpath.co. The other thing is that if you want to contribute to these docs, feel free to make a pull request, we will review it.

Also, remember: You must drop the URL of your tumblr blog into your allowed domains in the widget configuration.

On Google Tag Manager


  1. Go to the container you'd like to add the plugin to
  2. Click "Add new tag"
  3. Click "Custom HTML Tag"
  4. Paste in your UserPath code
  5. Check the "Support document.write" option
  6. Click continue
  7. Select "All Pages"
  8. Click "Create Tag"

GIF Walkthrough: On Google Tag Manager

On Tumblr


  1. Go to the profile icon in the top right
  2. Click on the Tumblr you want to add the UserPath plugin to
  3. Click "edit appearance"
  4. Click "edit theme"
  5. At the top on the left click on the tiny "Edit HTML" link
  6. Scroll to bottom of code
  7. Paste in your UserPath code

REMEMBER: You must drop the URL of your tumblr blog into your allowed domains in the widget configuration.

GIF Walkthrough: On Tumblr

On WordPress


  1. Sign in to your WordPress installation
  2. On the left hand menu hover over "Appearance"
  3. Then click "Widgets"
  4. Make sure you have a "Text" widget available in your available widget area (most common is sidebar) or add one
  5. Enter "UserPath plugin" as the title
  6. Paste your UserPath code into the "Content" box
  7. Click the "save" button

GIF Walkthrough: On WordPress

On Shopify


  1. Sign in to your Shopify account
  2. On the left hand menu click "Online Store"
  3. Then click "Themes" at the top
  4. Click the three dots "..."
  5. Then click "Edit HTML/CSS"
  6. Next scroll in sidebar with the folders/files that end with .liquid until you see "Snippets"
  7. Click that folder name
  8. Click the "Add New Snippet" link
  9. Enter "userpath.liquid" in the popup box
  10. Paste your UserPath code into the textarea
  11. Click the "save" button

GIF Walkthrough: On Shopify

On Weebly


  1. Sign in to your Weebly account
  2. Click "Edit Site" for the site you'd like to add UserPath too
  3. Drag and drop an "Embed Code" element
  4. Click to set Custom HTML
  5. Paste your UserPath code into the editor
  6. Click out of the editor - it saves automatically

GIF Walkthrough: On Weebly

On SquareSpace


  1. Sign in to your SquareSpace account
  2. Start editing the site you want to add UserPath too
  3. In the left bar click "Settings"
  4. Scroll down to the "Website" section and click "Advanced"
  5. Then click "Code Injection"
  6. Scroll down to the text box titled "FOOTER"
  7. Paste your UserPath code into the editor
  8. Click "Save" at the top

GIF Walkthrough: On SquareSpace

Using Plain HTML


  1. Open your text editor of choice
  2. Paste your UserPath code on every page or if using a template engine, just drop it in the master layout
  3. It should go right before the </body> end tag.

GIF Walkthrough: Plain HTML

On Magento


Coming soonish... Want it sooner? Email us!

On BigCommerce


Coming soonish... Want it sooner? Email us!

On 3DCart


Coming soonish... Want it sooner? Email us!

On PrestaShop


Coming soonish... Want it sooner? Email us!

App Download Plugin Installation

If you're trying to use the drop-in layout so you can place the app download form where ever you want on your page, then you must place the snippet provided to you in the HTML, like so:

<!-- begin UserPath embed code -->
<script type="text/javascript" src="//alpha.userpath.co/w/get/ability.js"></script>
<!-- end UserPath embed code -->
<div class="userpath-plug-f4a1aedz66"></div> <!-- place this where you want the form to show up -->

If you'd like to place the form in more than one place on the same page, simply copy the line with the div tag and place it multiple times in your HTML where ever you would like it to appear. For instance, say you have a header, a main section, a download section and footer. Let's say you want to have your App Download widget in the header and the download section and this is your HTML:

<!DOCTYPE html>
<html>
<head>
	<title>My App Homepage</title>
</head>
<body>
	<header>
		<button>Download for iOS</button>
		<button>Download for Android</button>
	</header>
	<section id="main">
		<ul>
			<li>It's free</li>
			<li>It's live streaming</li>
			<li>It's social</li>
			<li>It's local</li>
			<li>It's viral</li>
			<li>It's gamified</li>
		</ul>
	</section>
	<section id="download">
		<button>Download for iOS</button>
		<button>Download for Android</button>
	</section>
	<footer>
		<p>&copy; 2016 My App Homepage</p>
		<a href="#">about</a>
		<a href="#">contact</a>
	</footer>
</body>
</html>

You would simply add the script tag to the bottom, like so:

<!DOCTYPE html>
<html>
<head>
	<title>My App Homepage</title>
</head>
<body>
	... <!-- your code above this -->
	<!-- begin UserPath embed code -->
	<script type="text/javascript" src="//app.userpath.co/w/get/f4a1aedz66.js"></script>
	<!-- end UserPath embed code -->
</body>
</html>

and finally, drop the divs in the appropriate sections (header and download) like this:

<!DOCTYPE html>
<html>
<head>
	<title>My App Homepage</title>
</head>
<body>
	<header>
		...
		<div class="userpath-plug-f4a1aedz66"></div> <!-- place this where you want the form to show up -->
	</header>
	<section id="main">
		<ul>
			...
		</ul>
	</section>
	<section id="download">
		<div class="userpath-plug-f4a1aedz66"></div> <!-- place this where you want the form to show up -->
		...
	</section>
	<footer>
		...
	</footer>
	<!-- begin UserPath embed code -->
	<script type="text/javascript" src="//app.userpath.co/w/get/f4a1aedz66.js"></script>
	<!-- end UserPath embed code -->
</body>
</html>