Add deep links
Create deep links that navigate users to your Stripe app.
A deep link is a URL that reduces the number of navigation steps required for the user to open your app in the Dashboard. You can share deep links in user interfaces such as an email or website or use them when creating OAuth authorization workflows.
Before you begin
To navigate users to a Dashboard page that displays your app, you need an app with UI functionality.
Create the deep link URL
To create the URL of the deep link, you must use:
- The URL of a Dashboard page where you’ve defined a view
- The
open_parameterdrawer_ app - Your application ID, which is specified in the
idfield of yourstripe-app.manifest filejson
For example, if you define a view on the Customers page in the Dashboard (https://dashboard.) and your application ID is com.:
The test mode and sandbox deep link is:
<a href="https://dashboard.stripe.com/test/customers?open_drawer_app=com.example.deep-link">Deep Link</a>The live mode deep link is:
<a href="https://dashboard.stripe.com/customers?open_drawer_app=com.example.deep-link">Deep Link</a>
If a user clicks one of the deep links, it navigates them to your app that opens in the Customers page of the Dashboard.
Share the deep link
Make sure you use the live mode URL when you share the deep link to your users. You can share the link anywhere for users who’ve installed your app. If the user hasn’t installed your app before clicking the deep link, Stripe navigates them to a closed app that can’t open in the Dashboard.
Test the deep link
Log in to the Dashboard as a user who has installed the app.
Click the deep link.
If it navigates you to an app that can’t open, make sure you set the
open_parameter to the correct application ID.drawer_ app