Installation Guide (Developer)
What is “installation”?
Check out the Installation Overview if you haven’t already.
How do I install Appcues?
This section is intended for developers who will be able to add to the application code base.
1. Start the Installation Wizard
- Select the “I Want to Install Appcues Myself” option on the Installation page
2. Select the appropriate framework
- For Single Page Applications, see the Single Page Application Guide for specifics around handling corner cases like page/view changes
3. Add the JavaScript snippet
- Copy the snippet and paste it as the first item in your
<body>section on every page you want to use Appcues
- Your Account ID should automatically be set as the file name, if not you can find it in the Account API Keys section of the Account page
4. Identify your users
- Add the identify call, which will be different for each Framework so use the Installation Wizard for templates
5. Add User Properties
- Code templates are included in the Identify section of the Installation Wizard
- If you’re installing for someone else, ask them which properties are needed
- See the User Properties Overview for recommended properties
- Note: User Properties are absolutely necessary to appropriately utilize Appcues, include at least the recommended properties from the Overview above with your initial installation
6. Add Events (optional to start)
- Code templates are included in the Installation Wizard
- If you’re installing for someone else, ask them which events are needed
- See the Events Overview for recommended actions
7. For Single Page Apps, add re-initialization code
- Appcues relies on page loads to trigger flows, so it's important to re-initialize Appcues as users navigate your application
- Code templates are included in the Installation Wizard
- See the Single Page Application Guide for more
8. Check your work
- Test your installation, learn how to Open the Appcues Debugger and Test your Installation
- See your User Properties and Events in Settings, but note they will only show once a user with the Property has been identified or the Event has occurred