Manually Triggering Mobile Flows

Appcues Mobile is currently in beta and we are so excited for you to get it added to your apps! If you want to learn more or schedule a demo sign up for our mobile beta here.

Overview

When a Mobile Flow has been published, the flow can be triggered based on an app session, screen view, event, or manually. If a flow is set to trigger on app session, screen view, or event, it can also be triggered manually. One way to manually trigger a mobile flow is by using an action on a button in different flow.  Flows can also be triggered directly on the client using the Appcues.show() SDK function call, an Appcues SDK deeplink, or a custom app deeplink.

Manually Triggering with appcues.show() SDK function

Developers can trigger a flow directly in the app by using the appcues.show() call. This call takes a flow ID, also called an experience ID in the SDK code. The flow ID can be found by navigating to the flow settings, the format of the URL will be like https://studio.appcues.com/mobile/flows/{flow_id}/settings. With this ID, the show call can be added to the app to trigger the flow based on any desired user interaction.

appcues.show("FLOW_ID")

Appcues SDK Deeplink

An Appcues SDK deeplink can be used to open an application and trigger a flow. This can be great for launching an app and triggering a flow from an email or message. This deeplink will trigger the flow on the screen that first displays when the app is loaded.
This style of deeplink uses the App ID and Flow ID. The App ID is listed under Apps & Installation in Appcues Studio ( https://studio.appcues.com/settings/installation), the Flow ID can be found in the URL for the flow ( https://studio.appcues.com/mobile/flows/{flow_id}/settings).  These SDK deeplinks require the installation to be completed successfully with the custom URL scheme of the SDK added to the app.  For more information on SDK installation, refer mobile developers to the installation documentation.

appcues-{app_id}://sdk/experience_content/{flow_id}

Custom App Deeplink

Custom app deeplinks can be used to open an application and trigger a flow on a particular page. For these deeplinks a developer will need to add a custom deeplink to the app that uses the appcues.show() call.  This type of link is an extension of the functionality discussed in the first section above for the show() function. When this deeplink is triggered it will open the application, load a particular screen, and trigger the flow.  The coding of the logic for this type of deeplink is completely up to the host application, but an example of how you could structure this is shown below.

myapp://settings/profile?flow_id={flow_id}

The myapp://settings/profile portion is an example of a custom scheme (myapp://) in the host application, with a path that would route to some page in the app.  The app developer would then be able to see an optional flow_id query parameter on the link, and use that ID to call appcues.show("FLOW_ID") after navigating to the desired page in the app.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.