Skip to content

Frequently Asked Questions

How do I make Multi Page Tours on a Web App?

Contextual will support SPA (Single Page Apps) and normal URL-based apps. The navigation is built-in when you choose your next step in a tour.

This video explains:

How do I make Multi Page Tours on a Mobile App?

  • To create tours or walkthroughs of your app that go accross multiple pages, firstly you must have deeplinks enabled in your application.

  • If deeplinks are enabled, then all you have to do is enter the link of the page where you want the next tip to be displayed, in the "Deeplink" section of the tip or pop up. (Example below) Example of Deeplink Call To Action (CTA)

  • Important to note that if you would like users to be able to click on the back button and it is on a different page in your app, you will have to put the link to the previous page in the back button as a deeplink also.

In the context of mobile applications and Contextual, Deeplinking consists of providing a universal link (URI) that links to a certain location within an application. Due to the lack of a common protocols among native apps, you will have to ask your developers if they have set up deeplinking and the schema they have used within your application. Wikipedia entry.

  • Set up deeplinks for iOS here
  • Set up deeplinks for Android here
  • Set up deeplinks for React Native here

How do we integrate Contextual with our backend systems?

We have three methods:

  1. View/Screen and clickable elements per install are automatic

  2. You can tag user properties with a single line using our SDK. We support, text, numeric, datetime properties.

  3. You can tag user propertied with our REST/JSON API to our cloud. We are real-time in applying those properties.

You can view the endpoints by checking the API documentation link in the dashboard or refer to this article.


Sometimes people ask us how much Contextual impacts App Size. The answer is not much!

SDK Sizes

The Contextual iOS lib increases your App by only 2 MB (approx).

At compile time it contains 4 architectures:

  • armv7
  • arm64
  • i386
  • x86_64

First two are for devices and last two are for simulator. Our SDK must contain all the possible architectures so that customer can use it anywhere. When a customer packages App, the App will only increase on required architectures.

SDK implementation language

The iOS SDK is written in Objective-C, Will it cause any impact on customer apps written in Swift?

Our iOS SDK is written using Objective-C, Swift, Swift UI and we are developing our new features in Swift, SwiftUI, Combine and rewriting objective C into Swift.

For the Swift customers integrating with our SDK, it should not cause any compatibility issues because iOS supports interoperability between the above languages and secondly, everything is compiled into a binary.

For the Swift UI customers integrating with our SDK, it should be noted that we currently only support the use of UIViewControllers. This means that if you have a screen that you want to be usable with the SDK, it will need to have a UIViewController as its root "view". An example of this is how we recommend that customers set the rootViewController of the app's UIWindow to one of our custom subclasses of UIViewController, i.e. StreetHawkBaseViewController or StreetHawkBaseTableViewController.

Example for the Installation docs:

if let windowScene = scene as? UIWindowScene {
   let window = UIWindow(windowScene: windowScene)
   let childVC = UIHostingController(rootView: contentView)

   window.rootViewController = StreetHawkBaseTableViewController()
   childVC.view.frame = UIScreen.main.bounds
   childVC.didMove(toParent: window.rootViewController)

   self.window = window

Android FAQ

SDK Sizes

Current Size of Contextual for Android (2.+) is only 1.2MB.

Contextual also uses common libraries like Gson, Glide and Retrofit 2. This might affect the size of your app if you aren't currently using them.

Firewall Configuration

If your organization has a firewall that restricts the traffic to or from the Internet, you need to configure it to allow connectivity with Contextual in order for your apps to receive the content feed.

The following host/ports need to be whitelisted/unblocked in order for Contextual to function properly.

Host Port Component 443 SDKs 443 Dashboard 443 Dashboard 443 Dashboard 443 Creator

You can verify the firewall configuration using the following commands.

telnet 443
telnet 443

What is my App Key?

App key is the identifier used by Contextual to identify your app. You can find your app key in the dashboard.

Last update: 2023-04-12