Skip to content
Create account or Sign in
The Stripe Docs logo
/
Create accountSign in
Overview
Versioning
Upgrade your API version
Essentials
Tools
Stripe for Visual Studio Code
Features
Stripe health alertsFile uploads
AI solutions
Model Context ProtocolBuild agentic AI SaaS Billing workflows
Security and privacy
Stripebot web crawler
Extend Stripe
Partners
Partner certification

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 Stripe account ID where your app is installed. See User context for more details.
  • The URL of a Dashboard page where you’ve defined a view.
  • The apps parameter to specify your app and where to open it.
  • Your application ID, which is specified in the id field of your stripe-app.json manifest file.

Note

A legacy format using the open_drawer_app parameter continues to work for backwards compatibility, but the modern apps parameter format is recommended.

Deep link format

The structure of a deep link URL is:

https://dashboard.stripe.com/<MODE>/acct_<ACCOUNT_ID>/<PAGE>?apps[<APP_ID>][TARGET]=VIEWPORT_ID

Where:

  • MODE: test for test mode, or omit for live mode
  • ACCOUNT_ID: The Stripe account ID (starts with acct_)
  • PAGE: The Dashboard page to display (such as customers, invoices, or dashboard)
  • APP_ID: Your application ID from your manifest file
  • TARGET: Where to open your app such as drawer or modal
  • VIEWPORT_ID: Viewport IDs configured in your manifest file (such as stripe.dashboard.payment.list)

Examples

If you define a view on the Customers page in the Dashboard (https://dashboard.stripe.com/test/customers?) and your application ID is com.example.my-app:

  • The test mode and sandbox deep link is:

      <a href="https://dashboard.stripe.com/test/acct_id/customers?apps[com.example.my-app][drawer]=">Deep Link</a>

  • The live mode deep link is:

    <a href="https://dashboard.stripe.com/acct_id/customers?apps[com.example.my-app][drawer]=">Deep Link</a>

You can open your app on any Dashboard page where you’ve defined a view. For example, to open on the Dashboard home:

 <a href="https://dashboard.stripe.com/test/acct_id/dashboard?apps[com.example.my-app][drawer]=">Deep Link</a>

To create a deep link to your onboarding modal, use modal instead of drawer:

<a href="https://dashboard.stripe.com/acct_id/dashboard?apps[com.example.my-app][modal]=">Open in Modal</a>

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

  1. Log in to the Dashboard as a user who has installed the app.

  2. Click the deep link.

    If it navigates you to an app that can’t open, make sure that:

    • The apps parameter uses the correct application ID from your manifest
    • The account ID in the URL path is correct (format: acct_ followed by alphanumeric characters)
    • The user has the app installed for that account
    • The Dashboard page in the URL has a view defined for your app

See also