URL Scheme Protocol

📘

URL Schemes are used to define links that will only open in your app and not the device browser. This is helpful in login redirect flows or for a more seamless user experience. For example they can be used in redirects for login/authentication flows. URL Schemes will only work on mobile and are not compatible with desktop browsers.

For Android and iOS:

To enable url schemes, define a unique string not used by any other app which will serve as the "protocol". Standard URLs use http:// or https://, but these URLs will look like `youruniquestring://.

Assuming you use "youruniquestring", we will actually create two URL schemes for your app, i.e. youruniquestring.http:// and youruniquestring.https://. If you redirect a mobile user to either URL scheme, and they have your app installed, we will automatically open the specified link in the app.

For example, if you redirect a user to youruniquestring.https://example.com/path, your app will automatically open and the app will load https://example.com/path.