Installation - Technical Overview

While Appcues is a "code-free" tool, it does require a quick technical installation to go live in your app. Once installed, your published flows will be visible to users.

Click here for installation instructions

Basic Installation Requirements

At a minimum, installation requires the following steps:

1. Load Appcues
Load Appcues into your app by placing the following code snippet just after the opening  <body> tag. Make sure to use your company's Appcues account ID in the snippet.

<script src="//fast.appcues.com/{YOUR_APPCUES_ID}.js"></script>

2. Initialize Appcues and Identify Users
Use the Appcues.identify method to identify your user with a unique ID as the first argument. Capture additional user properties by passing in an object with the attributes as the second argument. Any properties set here will automatically be available for targeting. Below is an example:

  Appcues.identify('UNIQUE USER IDENTIFIER HERE', { 
  	email: 'jonathan@example.com', 
  	name: 'Jonathan Kim',
        created_at: 578725200000,
  	// Additional user properties
  });

You can call this method again throughout your app to add more attributes or update existing values as your users interact with your app.

By default, Appcues.identify will also call Appcues.start, which initializes Appcues in your app.

There may be instances where your app isn't tracking unique users (for example, on a public page that doesn't require log in). In this instance, you can use the Appcues.anonymous method and Appcues will assign an anonymous ID for those users. You can toggle between these methods for users who navigate between public and private pages. Learn more here.

3. Track Events (optional)
After a user has been identified, you can track your users' behaviors with Appcues.track. This method requires an event name as the first argument, and optionally, an object with additional attributes as the second argument.

The two examples below are valid ways to track an event.

  Appcues.track("Created auction");
  Appcues.track("Created auction", {
    section: "Home and Garden",
    length: "7 day"
  });

Learn more about events here.

Ready to get started?

Click here


Additional Step for Single Page Applications (SPAs): 

When users navigate your app, Appcues will show a flow 1) after the page has fully loaded and 2) if the user meets the conditions for your flows' targeting conditions.

If your app uses a framework such as React, Angular, or Backbone, or if your application doesn't reload the browser when users navigate, you'll need to call  Appcues.start in your application's router. Basically, whenever the URL changes, you'll want to call Appcues.start re-initialize Appcues. Click here for SPA instructions

To debug your Appcues.start call on a single page app, publish a sample flow using "Just Me" targeting and see if the flow shows automatically. You'll need to be logged into Appcues in order for "Just Me" targeting to work.

If your flow isn't showing right away and you need to refresh the page in order for Appcues to appear, it means that Appcues.start isn't being called correctly. Let us know and we can take a look for you.

You can also use the Appcues debugger to diagnose your install.

Still need help? Contact Us Contact Us