Skip to main content

HTML assets and apps

    URL scheme requirements

    • Updated

    URL schemes can be used to link to other Experiences, assets, and folders. This article outlines how to use additional parameters to open various types of content.

    Available parameters

    The following URL schemes are supported:

    URLDescriptionOptional GET parameters
    showpad://file/[file-id]

    Opens the specified file.

    • If the file is located in another Experience, you will jump to that other profile (unless the modal=1 parameter is added).
    • If the same file exists at multiple locations in different profiles, the app will start looking at the current profile first before moving on to another profile.
    • page
    • modal
    showpad://profile/[profile-id]Opens the specified Experience. 
    showpad://videoOpens Showpad video to record video messages. 
    showpad://folder/[folder-id]/file/[file-id]

    Opens a file in a specific folder.

    Beware that adding the modal=1 parameter will return you to the original context when the file is closed.

    • page
    • modal

    To build a URL scheme to a file, you'll need its ID.

    1. To identify a file's ID, click on the file in the Files library to open its detail panel.
    2. Click the copy icon next to File link in the Overview section.
    3. Paste the link where you can edit it. The file ID appears at the end of the File link.
      https://myorganization.showpad.biz/app/asset/395d5806-e691-4f21-acfa-bcd98a2a386f
    4. Include the file ID in the URL scheme.

    Tip: To identify a Page's ID follow the above steps after clicking on a Page in the Pages library.

    Optional GET parameters

    The optional GET parameters can be added after the first part of the URL, preceded by "?". You may want to use these parameters when the URL refers to an asset:

    • in another Classic folder. You would use modal=0 to end up in the folder where the target asset is.
    • on a Page. You would use modal=0 to end up in the folder where the Page that contains the asset is.
    • in an Advanced Experience. You would use modal=1 to end up in the folder where the URL is located.
    ParameterData TypeDescription
    pageinteger, 1-basedUse this to open a specific page in a PDF document or to open a file at a certain position in a folder.
    modalboolean, 1 or 0Use this to open a file in modal mode. This means it will be opened on top of the current context, so closing the file brings you back to the original context. Default value: 0.

    If you want to use more than one GET parameter, you can do so with an "&" between them, as shown in this example:

    showpad://file/78548788556b599d4977a7d58f70aa84?modal=1&page=5

    This will open the file with ID = 78548788556b599d4977a7d58f70aa84 in a modal window on Page 5.

    Related articles

    Get the latest apps and email integrations

    iOS App Store Google Play Store Microsoft Store