URL Scheme Protocol

Custom URL schemes are an advanced configuration option that allows you to define app-specific link formats (e.g., youruniquestring://example.com/path) that open content directly in your mobile app instead of a web browser. This functionality is particularly useful for mobile authentication redirect flows and creating advanced in-app navigation experiences.

🚧

Note

Custom URL schemes only work on mobile devices and are not supported in desktop browsers. Implementation is recommended for advanced developers.

How URL Schemes Work on Android and iOS

To implement a custom URL scheme, you must define a unique protocol identifier that is not used by any other app. While standard URLs begin with http:// or https://, custom schemes might look like:

youruniquestring://

Once configured, your app will recognize and handle URLs such as:

youruniquestring.https://example.com/path

If a user has your app installed and taps on a link using your custom scheme, the system will launch your app and open the specified path (e.g., https://example.com/path) within it.

❗️

Important

Use only lowercase letters in your custom scheme. Uppercase letters and numbers may lead to inconsistent behavior across platforms.

Example Use Case

Assume your app uses youruniquestring as the URL scheme. The following links can be used to trigger deep linking:

• youruniquestring.http://example.com/login
• youruniquestring.https://example.com/dashboard

When clicked on a supported mobile device, these links will open the corresponding screen within your app.

Platform-Specific Implementation Guides

• Define a Custom URL Scheme for Your iOS App (Apple Developer)
• Create Deep Links in Your Android App (Android Developers)

URL Schemes are an advanced configuration option used to define a non-standard link format that will only open in your app and not in the device browser e.g. youruniquestring://yoursite.com/path. This functionality is helpful in authentication redirect flows or for a more seamless user experience. URL Schemes will only work on mobile devices and are not compatible with desktop browsers. We recommend only experienced developers implement this functionality.