Learning & Support


Custom URL Schemes for article-based apps

Twixl Support Team Updated: - Created :

    A number of custom URL schemes can be used from within your article content, to link to a particular collection or article.


    Don't include the square brackets [], they are only there for demonstration purposes.

    1. URL schemes for collections

    From within your article content, you can use special URL schemes to link to a collection or article.

    You can use the following scheme:


    The syntax is as follows:

    Will link to the first article in a different collection.
    Will open the collection in browse mode.
    Will open the collection in detail mode.
    Will link to a specific article in a different collection.
    Will link to the parent collection of your current article.
    Will link to the root collection of your app.

    2. Article and page links


    If you want to add a link to a particular page in an article from within a browse page or article, you can do as follows:


    A number of other URL schemes for relative article and page navigation are also available:


    We support navo:// urls as well, so you don't need to convert these. Also see this KB-article.

    Go to the next article.
    Go to the previous article.
    Go to the first article of the publication.
    Go to the last article of the publication.
    Go to the next page (if at the last page of an article, go to the next page in the following article).
    Go to the previous page (if at the first page of an article, go to the last page of the previous article).
    Go to the first page of an article.
    Go to the last page of an article.
    Go to the top of a long-page article.
    Go to the end of a long-page article.

    3. Going back in Navigation History (> 5.5)

    This special url scheme can be used in all the same places as tp-collection links and goes back in the navigation stack for a specific number of steps. The syntax is as follows:


    The number-of-steps indicates how many steps you want to go back.


    Application XYZ has the following structure:

    • Root Collection (browse mode)
      • Languages Collection (browse mode)
        • English Collection (browse mode)
          • English Document 1 (detail mode)

    Some specific uses and what the result will be (in this case):

    • English document 1: tp-navigate-up://1 takes you to the English Collection.
    • English document 1: tp-navigate-up://2 takes you to the Languages Collection.
    • English document 1: tp-navigate-up://3 takes you to the Root Collection.
    • English document 1: tp-navigate-up://200 also takes you to the Root Collection.

    4. Paywall


    in an article-based app, there is no separate subscriptions dialog, as everything is part of the paywall which is shown as a layer top of a collection. You can manually trigger the paywall by using this special URL.

    5. Entitlements

    Show the Entitlements sign-in form


    Triggers the entitlements sign-in form.

    Show the Entitlements register form


    Triggers the entitlements register form. This only works if the entitlements server provides a "register" action. Available in the kiosk info cell - infoCell.html

    Get entitlement token


    Get the current entitlement token, passing it as the argument to the callback_function. If no callback function is specified, it will default to twixlKioskOnGetEntitlementToken.

    Clear entitlement token


    Clears the entitlements token (can be used for testing purposes). Available in the kiosk info cell - infoCell.html

    6. Phone call


    Allows you to trigger a phone call. Note that this will work on phones only.



    7. Searching (> 5.5)

    To trigger the search-dialog in article-based applications, you use the following url-schemes:

    Custom URL Scheme Function


    Shows an empty dialog
    Executes a search-command with the specified keyword

    Example (search for content with the word twixl):


    8. Launching an app

    It is possible to trigger launching an app from within a Twixl publication using the following scheme:

    Please note that the implementation is slightly different on iOS vs Android.

    • iOS: the URL scheme is the same as the application identifier:

    e.g. if the app identifier is com.twixlmedia.myapp -> then the URL to launch the app would be: com.twixlmedia.myapp://

    • Android: the URL scheme is the same as the app identifier without the dots, dashes, underscores and all lowercase:

    e.g. if the app identifier is com.twixlmedia.myapp -> the the URL to launch the app would be: comtwixlmediamyapp://


    This will only work if the app is already installed on the device.

    9. Launching third-party apps

    In this scenario, it depends on the url schemes supported by the app you want to launch. E.g. an app which can be opened using the url scheme com.mycustomapp:// can be launched by simply creating a hyperlink as follows:

    <a href="com.mycustomapp://">Launch My Custom App</a>

    This is now supported anywhere in an article-based / issue-based / single-issue app where you can enter an URL.


    This will only work if the app has already been installed on the device.

    10. Opening a hyperlink in the device browser


    Although in most cases, you want to keep readers in the embedded browser, sometimes you may want to open a link directly in Safari on iPad or in the default browser on Android. A good use case for this is if you want to link to a PDF that you want readers to be able to download.

    You can do this by adding this extra parameter to your URL. Available for Hyperlinks.

    Some examples:

    The URLs below will open in the embedded app browser:


    And these will open in the device browser:


    11. Open in embedded web browser


    Adding this url parameter to a hyperlink in an infoCell will open the link in the embedded web browser instead of opening within the infoCell itself.

    12. Hamburger-Menu (> 7.0)

    You can show / call the Hamburger-Menu with the following custom url-scheme:



    In order to use this custom-url scheme, you. need to activate the Hamburger-Menu in your article-based app. For more info about the Hamburger-Menu, see this KB-article.

    13. Get the device info via JavaScript

    Adding the following JavaScript code to your Content Item, Web Viewer, Web Overlay Button, ...

    window.location.href = "tp-device-info://";

    will execute the following JavaScript function:

    function twixlOnGetDeviceInfo(deviceUDID, appVersion, appIdentifier, entitlementToken) {

    This then gives you access to the Device UDID, the app version, the app identifier and the entitlement token. You can also customize the name of the function that gets called:

    window.location.href = "tp-device-info://myCustomFunctionName";
    function myCustomFunctionName(deviceUDID, appVersion, appIdentifier, entitlementToken) {


    For more info, see the sample files on this GitHub-page.

    Was this article helpful?

    2 out of 3 found this helpful