Mobile URL Schemes

Quick Brick apps support a list of URL Schemes that can be used for opening specific screens in the app.

info

URL Schemes creation are mainly used for creating deep links when sending push notifications.

Following are the list of URL Schemes that are available on Quick Brick:

Replace <URL_SCHEME> with the URL Scheme you defined in your Zapp version on the version edit form

Open the app

<URL_SCHEME>://

Open a screen by id

<URL_SCHEME>://present?screen_id=<SCREEN_ID>

The screen id is located on each screen inside Zapp Studio

zapp-studio

Open the video player (VOD or live)

<URL_SCHEME>://present?data_source=<BASE64_ENCODED_DATA_SOURCE_URL>&entry_id<ENTRY_ID>

BASE64_ENCODED_DATA_SOURCE_URL: Please refer to Appendix A.

<ENTRY_ID> The corresponding entry id to open. The entry id should be of type video or channel.

If the <ENTRY_ID> is not URL safe you'll need to Base64 encode it and then URL encode it. Use the URL Scheme Generator to do the work for you.

Open a connected screen

<URL_SCHEME>://present?screen_id=<SCREEN_ID>&data_source=<BASE64_ENCODED_DATA_SOURCE_URL>&entry_id<ENTRY_ID>

SCREEN_ID: the screen id to open. The screen id is located on each screen inside Zapp Studio.

BASE64_ENCODED_DATA_SOURCE_URL: Please refer to Appendix A.

<ENTRY_ID> The corresponding entry id to open

If the <ENTRY_ID> is not URL safe you'll need to Base64 encode it and then URL encode it. Use the URL Scheme Generator to do the work for you.

Appendix A - Generating the encoded data source URL

tip

Instead of building the URL on your own use the URL Scheme Generator 🎉

Follow the following steps to create your URL Scheme Manually:

tip

If you have an already existing feed locator URL you can jump to stage 5

info

Feed Locator definition:

For V1 Layouts, The feed locator is the DSP URL scheme that the app is using to retrieve the feed. V1 feed locator are structured as follows:

<DSP-URL-SCHEME>://fetchData?type=<DATA_TYPE>&url=<FEED_ID>

For V2 Layout (Pipes2) the feed locator is a a simple html URL that returns a valid V2 JSON Feed.

Step 1

Use an existing JSON feed or create new one and host it on a CDN. The feed should have at least one entry (the entry you would like to open).

Make sure that the id of the entry is a string a not a number.

Step 2

Base64 encode the URL from step 1

Step 3

URL encode the output of step 2

Step 4

Insert the result of step 3 inside <RESULT_OF_STEP_3> in general-provider://fetchData?type=FEED_JSON&url=<RESULT_OF_STEP_3>

Step 5

Base64 encode the URL (The Feed locator URL) from step 4

Step 6

URL encode the output of step 5