Deep links

6min

Deep linking in mobile apps is a powerful tool that enhances user experience by creating seamless navigation between the app and external sources. Deep linking allows you to land directly on specific content or pages within an app, bypassing the need to navigate through a series of menus. This is particularly useful in marketing campaigns, social media links, or emails where you want to direct a person to a specific product, article, or feature within your app.
Contact [email protected] to get your branded app's deep link. 
Format
Deep linking uses a uniform resource identifier (URI) to link to an app or a specific location within a mobile application. The deep link is built up in stages, and the depth depends on where in the app you want to land. The full URI format is shown below:
https://{app.domainname.com}/{appname}/app/solution/{solutionId}/jig/{jigname}?{inputname=inputvalue}
An example of a built-up deep link:
﻿https://app.jigx.com/jigx/app/solution/8e535f78-4e36-4716-8c01-4567bea60bj9/jig/[email protected]﻿
The URI is built up with the following values: 
URI elements
Description
app.jigx.com
For all jigx apps, use the app domain app.jigx.com.
jigx 
name of the app.
solutionId
The solutionId is found in management >solution> solution details, for example, 8e535f78-4e36-4716-8c01-3465bea60bj9.
jigname 
jigId/jig-name, for example, support-form.
inputname
The name used in the input expression, i.e. [email protected].{inputname}.
inputvalue 
The value to be used as the input.
Link to an app
To open a 
﻿ or branded app, use the following deep link:
https://{app.jigx.com}/{jigx}/app/
If you are logged out of the app and click the link, you will be directed to the login screen. 
If you are currently logged into the app, the link will open the app and display the 
﻿.
Link to a jig screen (basic deep link)
A deep link to a 
﻿ screen directs you to a specific location within the app if it has already been installed.
https://{app.jigx.com}/{jigx}/app/solution/{solutionId}/jig/{jigname}
Link to a jig with inputs (contextual deep link)
 A contextual deep link includes additional information, such as user data, input value, or a parameter, providing a personalized experience. For example, a link that opens a form and prepopulates a field with an email address.
Input:
https://{app.domainname.com}/{appname}/app/solution/{solutionId}/jig/{jigname}?{inputname=inputvalue}
An example of the built-up deep link:
﻿https://app.jigx.com/jigx/app/solution/8e535f78-4e36-4716-8c01-34657bea60bj9/jig/[email protected]﻿
In the solution, the YAML code to accept the deep link input is:
YAML
input-query-parameter
datasources:
  participantList: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
      entities:
        - default/hikers
      query: |
        SELECT
          id,
          '$.name',
          '$.contact',
          '$.photo',
          '$.participant-group',
          '$.hiker-email'
        FROM
        [default/hikers]    
        WHERE '$.hiker-email' = @email
    # create a query parameter for the deeplink input
      queryParameters:
        email: [email protected]
datasources:
  participantList: 
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
      entities:
        - default/hikers
      query: |
        SELECT
          id,
          '$.name',
          '$.contact',
          '$.photo',
          '$.participant-group',
          '$.hiker-email'
        FROM
        [default/hikers]    
        WHERE '$.hiker-email' = @email
    # create a query parameter for the deeplink input
      queryParameters:
        email: =@ctx.jig.inputs.email
﻿
Link to an external app from a jig
Add a deep link in a 
﻿ that directs you to a different mobile application, even to a specific location within that application. This link allows you to navigate seamlessly from one app directly to a particular page or piece of content in another app, without having to navigate through the app's homepage or menu. For example, tapping on an address link in a contacts 
﻿ could directly open Google Maps showing the location. 
Considerations
Deep linking to an external app can only be configured in actions and swipeable actions using the action.open-url.
An app's deep links often differ depending on the mobile OS (iOS or Android). This will require you to configure a deep link for each OS in the 
﻿. See the example below that deep links into the iOS and Android Google Maps app:
iOS-open-url
Android-open-url
actions:
  - children:  
      - type: action.open-url #android
        options:
          title: Directions
          # Add the external app's Android deep link in the url
          url: google.navigation:q=2920+Zoo+Dr,San+Diego,CA+92101,United+States
 
actions:
  - children:  
      - type: action.open-url #android
        options:
          title: Directions
          # Add the external app's Android deep link in the url
          url: google.navigation:q=2920+Zoo+Dr,San+Diego,CA+92101,United+States
 
﻿
﻿

Updated 05 Aug 2024

Did this page help you?

Additional functionality

Localization

Docs powered by Archbee

TABLE OF CONTENTS

Format

Link to an app

Link to a jig screen (basic deep link)

Link to a jig with inputs (contextual deep link)

Link to an external app from a jig

URI elements	Description
app.jigx.com	For all jigx apps, use the app domain app.jigx.com.
jigx	name of the app.
solutionId	The solutionId is found in management >solution> solution details, for example, 8e535f78-4e36-4716-8c01-3465bea60bj9.
jigname	jigId/jig-name, for example, support-form.
inputname	The name used in the input expression, i.e. [email protected].{inputname}.
inputvalue	The value to be used as the input.