This is a guided overview to installing Appcues Mobile into your Segment-connected iOS, Android, or ReactNative mobile application. For information on installing Appcues onto your web platform via Segment, check out the guide here!

Interested in our data security measures? Please review our Trust Center for details.

Before You Get Started

•  Identify who on your team has access to Segment and can add the additional components

What Do We Mean by “Install”?

There are a few key components that together create a successful Appcues installation. While this guide will cover these items in more detail, below in a brief overview of what makes an Appcues installation.

Installation requires an hour or more of work for a developer with knowledge of how your app tracks user properties, screens, and events. You will need access to your team's Appcues account and Segment instance to complete the installation.
 

Segment Components

Already included in your Segment installation, and the data is passed into Appcues via the plugin

• Add the Appcues SDK Script to your Product - Appcues is added to your app to connect to your Appcues account and show the content you've built
• Identify Users and Groups - Tell Appcues when a user is present, and send information about who that user is. This is used for targeting experiences and segmentation
• Track Screens - Recognize where the user is within your app. This is used for screen-based targeting
• Track Events - Tracking events with Appcues allows you to measure your users' engagement with your app. These events can also be used for targeting and segmentation
   

Additional Components

Not handled in Segment, and are implemented into your app directly

• Deep Link Support - Used for debugging, previewing, screen capture, and navigation across your app
• Element Recognition - Used with Anchored Tooltips to connect a tooltip to a specific element on screen
• FrameViews - Creates a designated container within your app to display Appcues Embeds

All components are required for full functionality and feature usage of Appcues Mobile

Ready to install via Segment? Continue through this guide for next steps!

Adding Appcues

Required

1. Register Your App(s) in Studio
   • This creates your AppIDs, which is used for connecting your app to your Appcues account for building and publishing Appcues experiences
   • If you’d like to manage separate instances, you can register an AppID for each, then configure a Destination for each (see Step 2 below)
     Don’t have multiple instances, or don’t want to manage them in Appcues? Don’t worry! Flows can be targeted to specific users when testing live.
2. Configure the Appcues Mobile Destination
   • In Segment, navigate to Destinations and search for “Appcues Mobile”
   • Click “Configure Appcues Mobile”
   • In the configuration settings, you'll add:
     • Your Appcues AccountID, found on your Account Settings page, and
     • Your registered AppID, found on your Installation Settings page
       Adding multiple apps? Configure a destination for each AppID generated in Step 1
3. Add the Plugin
   • iOS
   • Android
   • ReactNative
      

Configure URL/Deep Linking

Required

• Deep linking is required for debugging, previewing, and screen capture (required for Anchored Tooltips and applying a background in the Mobile Builder). Your app must also be set up to support URL schemes and deep linking
• Select your framework below for more details:
  • iOS
  • Android
  • ReactNative

Recognize Screen Elements

Required for Anchored Tooltips

• When using Anchored Tooltips, the screen elements must be recognizable in the captured screen. This allows for secure placement that maintains through different screen sizes or element location on the screen
• Select your framework below for more details:
  • iOS
  • Android
  • ReactNative

Build FrameViews

Required for Embeds

• To publish an Appcues Mobile Embed, FrameViews must be configured to store the Embed. These are pre-set containers that are added throughout your app where you would like to host an Embed
• Select your framework below for more details:
  • iOS
  • Android
  • ReactNative
     

Sending Appcues Events to Segment or Other Analytics Tools

Add the Event Listener to your app to pass Appcues events into Segment and other mobile-connected tools (Heap, Amplitude, Google Analytics, etc.)

• Sends the following events:

• Select your framework below for more details:
  • iOS
  • Android
  • ReactNative

Having Issues Getting Installed?

If you have any questions or issues regarding your mobile installation, please contact us at support@appcues.com!