A Permalink is a link that opens a page in your app and shows a specific Flow, Checklist, or NPS survey there, whatever its targeting says. Use one to let users relaunch a tour, to chain experiences together, or to show an experience from an email. Also known as a deep link or share link.

How Permalinks work

A Permalink is a page URL with appcue= and the experience's ID added to the end. When a user opens it, Appcues shows that experience straight away. Page targeting, audience targeting, and frequency are all ignored.

The experience must be published for its Permalink to work.

Copy a Flow's Permalink

The Appcues App builds the link for you from the Flow's Build URL. The Flow must be published and have a Build URL.

Flows 2.0

1. Click Experiences and find the Flow.
2. Open the Flow's menu and click Permalink. The link is copied to your clipboard.

You can also open the Flow and click More actions (⋯) > Permalink.

Legacy Flows

1. Click Experiences and open the Flow.
2. Click More actions (⋯) > Permalink. Permalink options opens.
3. Copy the Permalink, or copy the Button code to add a button to your app that shows the Flow.

If Permalink isn't in the menu, publish the Flow and check that it has a Build URL in its settings.

Build your own Permalink

Build a Permalink yourself to show a Checklist or NPS survey, or to show a Flow on a page other than its Build URL.

1. Open the experience in the Appcues App and click Settings.
2. Under Who changed this, click the copy icon next to Experience ID. For a Checklist, use the ID in the Checklist page's URL.
3. Add ?appcue= and the ID to the end of any page URL in your app, for example https://yourapp.com/dashboard?appcue=EXPERIENCE_ID.

If the URL already has a ?, use & instead: https://yourapp.com/dashboard?page=3&appcue=EXPERIENCE_ID. A finished Permalink has only one ?.

Ways to use Permalinks

• Relaunch a tour or announcement. Add a Permalink to a help menu or a button so users can see a Flow again.
• Chain experiences. Set the last step's button to Go to URL with another experience's Permalink.
• Bring back a dismissed Checklist, or open the next Checklist in a sequence.
• Ask for NPS from an email. When the user opens the link, the survey shows on the page in your app. It doesn't show inside the email.

For a Flow that should only show from a Permalink, set its trigger to Only manually in When this shows, so it doesn't also show when a user reaches the page.

Good to know

• Anyone with the link sees the experience, including users outside its audience. Only share a Permalink with people you mean to show it to.
• Users can open a Permalink as many times as they like, NPS surveys included.
• A Permalink takes priority over every other Appcues experience on the page.
• A Checklist opened from a Permalink shows on every page until the user dismisses it.

If a Permalink doesn't work

• Nothing shows: check that the experience is published and that Appcues is installed on the page. Open the Appcues debugger and look for green checkmarks.
• The page loads but the URL breaks: check that the link has only one ?.
• Permalink is missing from the menu: publish the Flow and add a Build URL.

Still stuck? Contact support with the Permalink, the experience's Experience ID, and the User ID of someone it didn't work for.