Skip to main content

Deep Linking in FAQs

Using custom URL schemes to support deep linking in your app

Note

All the public APIs in the SDK should be called after initializing the SDK via HelpshiftSdk.install() API

Deep Linking in FAQs​

Use custom URL schemes to direct users to particular sections of your app from Helpshift FAQs. You can use these schemes to provide a more seamless experience for the user. For example, if your iOS app has a registration screen, clicking on a registration link in an FAQ can directly take the user to that screen.

Insert custom URL schemes in FAQs​

When editing your FAQ, select the text and then click on create a link.

add-deep-link-to-faq-sdkx-1.png

In the dialog that pops up, enter your custom URL and save the FAQ.

add-deep-link-to-faq-sdkx-2.png

Deep linking is a custom linking URL that gives the developers the freedom to decide what the URL can do when the user clicks on a Custom URL. Examples of deep linking include instances when the user needs to be redirected to a review page from the chat screen, or from the chat screen to an FAQ page or an FAQ section.

In deep linking, you are allowed to set Custom URL schemes like myscheme://example.com. For example, the URL myscheme://FAQID (where FAQID is the publish ID of an FAQ), will open up the relevant FAQ in the conversation screen. In order for the developers to handle myscheme, they will have to call showSingleFAQ API with the corresponding FAQ ID.

To handle the custom URLs in your iOS app, make sure first that your app's Info.plist supports the custom URL scheme that you've provided in the FAQs. More information

You will then need to implement, onOpenURL:(NSNotification*)notification in Helpshift/Plugins/iOS/HsUnityAppController.mm, in which HsUnityAppController class conform to AppDelegateListener protocol.

- (void)onOpenURL:(NSNotification*)notification;

    NSURL *url = notification.userInfo[@"url"];

    if([[url host] isEqualToString:@"helpshift"]) {
        NSArray *components = [[url path] componentsSeparatedByString:@"/"];
        if([components count] == 3) {
            if([[components objectAtIndex:1] isEqualToString:@"section"]) {
                [Helpshift showFAQSection:[components objectAtIndex:2] with:[UIApplication sharedApplication].keyWindow.rootViewController config:@{}];
            } else if([[components objectAtIndex:1] isEqualToString:@"faq"]) {
                [Helpshift showSingleFAQ:[components objectAtIndex:2] with:[UIApplication sharedApplication].keyWindow.rootViewController config:@{}];
            }
        }
    }
}