SDK Configuration

Helpshift provides several config options which can be used to customize behaviour of the SDK.

Note

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

Install time configurations

Enable In-App Notifications

If you do not want the in-app notification support provided by the Helpshift SDK, you can set the flag to false.

On setting this flag to false, the SDK will stop showing notifications in the notification tray of the device but it will fetch messages in background. This behaviour is different for iOS, please refer here

The default value of this flag is true i.e., the in-app notification will be enabled.


Flag	HelpshiftSdk.ENABLE_INAPP_NOTIFICATION
values	true/false
default	true

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;

    void Awake(){
      this.help = HelpshiftSdk.GetInstance();
      Dictionary<string, object> configMap = new Dictionary<string, object>();
      configMap.Add(HelpshiftSdk.ENABLE_INAPP_NOTIFICATION, false);
      help.Install(appId, domainName, configMap);
    }
}

Notification Icon

By default the application icon is used as the notification icon. You can customize the notification icon using the config in the install call.

You do not need to specify the file extension for the icon image. If your icon image's file name is "icon.png", you just need to pass "icon" to helpshift config and add the "icon.png" file at <project-dir>/Assets/Plugins/Android/res/drawable.

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;

    void Awake(){
      this.help = HelpshiftSdk.GetInstance();
      Dictionary<string, object> configMap = new Dictionary<string, object>();
      configMap.Add(HelpshiftSdk.NOTIFICATION_ICON, "<icon-image-file-name>");
      help.Install(apId, domainName, configMap);
    }
}

Large Notification Icon

By default the application icon is used as the notification icon. If you want to specify the large notification icon also to show up in the notification tray, you can specify that using the config in the install call.

You do not need to specify the file extension for the icon image. If your icon image's file name is "large_icon.png", you just need to pass "large_icon" to helpshift config and add the "large_icon.png" file at <project-dir>/Assets/Plugins/Android/res/drawable.

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;

    void Awake(){
      this.help = HelpshiftSdk.GetInstance();
      Dictionary<string, object> configMap = new Dictionary<string, object>();
      configMap.Add(HelpshiftSdk.NOTIFICATION_LARGE_ICON, "<large-icon-image-file-name>");
      help.Install(appId, domainName, configMap);
    }
}

Notification Sound

Note

The sound provided here would only be set for the default notification channel that the SDK creates on its own on Android OS 8.0 & above. This sound can only be set once on the default channel and it won’t change if a different sound resource is passed.
If the sound needs to be changed later on, it is recommended to create your own notification channels. Refer this.

By default the default device notification sound is used for helpshift notifications. You can customize the notification sound using the config in the install call.

You do not need to specify the file extension for the sound file. If your sound file name is "notificaton_sound.mp3", you just need to pass "notification_sound" to helpshift config and and add the "notificaton_sound.mp3" file at <project-dir>/Assets/Plugins/Android/res/raw.

For example:

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;

    void Awake(){
        this.help = HelpshiftSdk.GetInstance();
        Dictionary<string, object> configMap = new Dictionary<string, object>();
        configMap.Add(HelpshiftSdk.NOTIFICATION_SOUND_ID, <sound-file-name>);
        help.Install(appId, domainName, configMap);
    }
}

Notification Channels

Starting from Android Oreo, Helpshift notifications will create a default channel named In-app Support. If you want to customize the name for the default channel, you can do so by using the config in the install call.

For Example-

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;

    void Awake(){
      this.help = HelpshiftSdk.GetInstance();
      Dictionary<string, object> configMap = new Dictionary<string, object>();
      configMap.Add(HelpshiftSdk.NOTIFICATION_CHANNEL_ID, <your-channel-id>);
      help.Install(appId, domainName, configMap);
    }
}

Enable Logging

Upon setting enableLogging to true, Helpshift SDK logs will be generated in the Android logcat. Turning on logging can help developers resolve common integration issues.


Flag	HelpshiftSdk.ENABLE_LOGGING
Values	`"true"`/`"false"`
Default	`"false"`

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;

    void Awake(){
      this.help = HelpshiftSdk.GetInstance();
      Dictionary<string, object> configMap = new Dictionary<string, object>();
      configMap.Add(HelpshiftSdk.ENABLE_LOGGING, true);
      help.Install(appId, domainName, configMap);
    }
}

FAQ Filtering by tags

We have FAQ filtering capability by tags. With the goal of helping the end user see focused & related content e.g. basis the user demographic or device profiles, developers can now choose this capability for FAQ filtering and showing a focused FAQ list to the right audience.

Typical cases why you would want to use FAQ filtering are:

You want to show specific FAQs for specific audience. E.g. if you may categorize the users as ‘beginner’, ‘intermediate’ or ‘expert’ based on your business logic.
You may want to show specific FAQs based on the device. E.g. a set of FAQs for iPad vs. iPhone.

FAQ filtering is a 2 step approach :

FAQs need to be classified using the <issue tags> field on the dashboard e.g. tags iphone & ipad.
Once the FAQs are tagged, they can be filtered at the SDK using the filter options described here.

Note

Helpshift has 2 types of tags mainly ‘Issue Tags’ & ‘Search Tags’.

Issue tags are used to filter the FAQ list on the SDK with the filter rules.
Search tags (a.k.a Search Keywords) When performing in-app search, Helpshift SDK gives preference to these keywords. You can also use this to add alternative keywords that users might search for, but which may not exist in the FAQ title or the content.

How to use FAQ filtering

This will be a config option which will be supported by the showFAQs and showFAQSection APIs.

The filter option will be a map containing 2 keys

operator : one of AND, OR, NOT which will serve as conditional operators for the given tags.
tags : the actual tags in the query

The filter option should be added as an object against key “filter” in the map config that is taken by showFAQs, showFAQSection and showSingleFAQ APIs.


Option:	`filter`
Sub-Options:	`tags` / `operator`
Default	`null`
Min SDK	v10.0.0
Supported by	`showFAQs`, `showFAQSection`, `showSingleFAQ`

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;
    void Awake() {
      this.help = HelpshiftSdk.GetInstance();
      help.Install(appId, domainName);
    }

    void OpenHelpshift() {
      Dictionary<string, object> config = new Dictionary<string, object>();

        Dictionary<string, object> filter = new Dictionary<string, object>
        {
            { "tags", new string[] { "tag1", "tag2" } },
            { "operator", "AND" }
        };

        config["filter"] = filter;

        help.ShowFAQs(config);
    }
}

Conversation prefill text

Setting conversationPrefillText in the config allows you to set some text in the user's input box. This text will be inserted provided that:

There is no ongoing (active) issue for the user.
Text inputs are enabled for new conversations (e.g. the User Reply Input Type is not "Only Intent Menu").

Note

The end-user can edit this text before sending it. There is a limit of 1,000 characters for this configuration value, so only the first 1,000 characters will be kept in the user input.

We recommend keeping your actual text even shorter for a better user experience, since the user has to read and edit it before sending it.

Example:

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;
    void Awake() {
      this.help = HelpshiftSdk.GetInstance();
      help.Install(appId, domainName);
    }

    void OpenHelpshift() {
      Dictionary<string, object> configMap = new Dictionary<string, object>();
      configMap.Add("conversationPrefillText", "INSERT YOUR PREFILL TEXT");
      help.ShowConversation(configMap);
    }
}

Conversation Initial User Message

Initial user message configuration, initialUserMessage, helps you send the first message in a conversation on behalf of the user so that certain workflows are automatically triggered based on that message.

You should set this configuration before a conversation starts. In other words, it works only when there is no active conversation for the user i.e. when a new user opens the chat screen for the first time or existing user has already closed an ongoing conversation.

Note

If you set this configuration in the middle of an existing conversation, it will not have any effect.

Example:

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;
    void Awake() {
      this.help = HelpshiftSdk.GetInstance();
      help.Install(appId, domainName);
    }

    void OpenHelpshift() {
      Dictionary<string, object> configMap = new Dictionary<string, object>();
      configMap.Add("initialUserMessage", "INSERT YOUR INITIAL USER MESSAGE");
      help.ShowConversation(configMap);
    }
}

Clearing Initial User Message

If the end user starts a new conversation immediately in the same session, then, by default, the initial user message is applied to all subsequent issues in the same session. You can change this behaviour by setting the initialUserMessage key in subsequentIssuesInSameSessionConfig to an appropriate value.

You can set the initial user message to an empty string, which will clear it and allow the end-user to type a message for their subsequent issues. Alternatively, you can also supply a non-empty string which will be used for all subsequent issues in the same session.

We recommend setting this value to an empty string unless you want to run specific automation flows for subsequent issues in the same session.

Note

Currently, only the initial user message can be reset. Tags, Custom Issue Fields, and Conversation Prefill Text values stay the same for subsequent issues in the same session.

Example:

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;
    void Awake() {
      this.help = HelpshiftSdk.GetInstance();
      help.Install(appId, domainName);
    }

    void OpenHelpshift() {
      Dictionary<string, object> subsequentIssuesInSameSessionConfigMap = new Dictionary<string, object>();
      subsequentIssuesInSameSessionConfig.Add("initialUserMessage", "")

      Dictionary<string, object> configMap = new Dictionary<string, object>();
      configMap.Add("initialUserMessage", "INSERT YOUR INITIAL USER MESSAGE");
      configMap.Add("subsequentIssuesInSameSessionConfig", subsequentIssuesInSameSessionConfig)

      help.ShowConversation(configMap);
    }
}

For outbound support scenarios make sure to add this config in the user specific config callback getLocalAPIConfig you get when you register HelpshiftSdk.SetHelpshiftProactiveConfigCollector(new ProactiveConfigCollector()).

// initialise proactiveConfig collector

   public class ProactiveConfigCollector : IHelpshiftProactiveAPIConfigCollector
    {
        public Dictionary<string, object> getLocalApiConfig()
        {
            Dictionary<string, object> proactiveConfig = new Dictionary<string, object>();
            Dictionary<string, object> subsequentIssuesInSameSessionConfig = new Dictionary<string, object>();

            // user specific config
            proactiveConfig.Add("initialUserMessage", "INSERT YOUR INITIAL USER MESSAGE");

            subsequentIssuesInSameSessionConfig.Add("initialUserMessage", "");
            proactiveConfig.Add("subsequentIssuesInSameSessionConfig", subsequentIssuesInSameSessionConfig)
            ..
            ..
            return proactiveConfig;
        }
    }

Screen Orientation

The screen orientation of Helpshift SDK screens can be fixed by setting the screenOrientation to constants available in the ActivityInfo class. For example, you may want to fix the orientation to ActivityInfo.SCREEN_ORIENTATION_PORTRAIT for mobile users and ActivityInfo.SCREEN_ORIENTATION_LANDSCAPE for tablet users.


Flag	HelpshiftSdk.SCREEN_ORIENTATION
values	integer values for orientation from ActivityInfo class
default	1 (which is ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED)

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;

    void Awake(){
      this.help = HelpshiftSdk.GetInstance();
      Dictionary<string, object> configMap = new Dictionary<string, object>();
      // To make it landscape
      configMap.Add(HelpshiftSdk.SCREEN_ORIENTATION, 0);
      help.Install(appId, domainName, configMap);
    }
}

Enable Contact Us

Controls the visibility of the Helpshift Contact Us button when a user is viewing FAQs. You can customize this option to make it easier or more difficult to contact support. If specified, this configuration takes precedence over the value of Enable Contact Us set on admin dashboard.

Possible values are "ALWAYS" / "AFTER_VIEWING_FAQS" / "AFTER_MARKING_ANSWER_UNHELPFUL" / "NEVER".

For example

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;
    void Awake() {
      this.help = HelpshiftSdk.GetInstance();
      help.Install(appId, domainName);
    }

    void OpenHelpshift() {
      Dictionary<string, object> configMap = new Dictionary<string, object>();
      configMap.Add("enableContactUs", "AFTER_VIEWING_FAQS");
      help.ShowFAQs(configMap);
    }
}

Best Practices

Provide tier-based support by setting enableContactUs to ALWAYS for paid users and AFTER_VIEWING_FAQS for unpaid ones.
Provide country based support by setting enableContactUs to ALWAYS for local users and AFTER_VIEWING_FAQS for foreign ones.

Full privacy

In the config dictionary of help.ShowConversation(config); API at the time of calling this API, setting the fullPrivacy option to true ensures COPPA compliance by:

Disabling user-initiated screenshots (users will not be able to attach files, including images, using SDK).
Making sure that Personally Identifiable Information (PII) such as name and email are not collected by SDK (using Identity Bot and/or the helpshiftConfig object). This means that if you set userName and userEmail, with fullPrivacy set to true, Helpshift will not use the userName and userEmail values.

Moreover, in scenarios where the user attaches objectionable content, it becomes a huge COPPA compliance concern. This option helps to solve this problem.

For example

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;
    void Awake() {
      this.help = HelpshiftSdk.GetInstance();
      help.Install(appId, domainName);
    }

    void OpenHelpshift() {
      Dictionary<string, object> configMap = new Dictionary<string, object>();
      configMap.Add("fullPrivacy", true);
      help.ShowConversation(configMap);
    }
}

Initiate new conversation on chat screen load

In config dictionary of showConversation:, setting the initiateChatOnLoad option to true will start a new conversation if the previous issue is resolved, without the end user clicking the New Conversation button or going through the post resolution flows like feedback bots of the previous issue.


Option:	`initiateChatOnLoad`
Values:	`true` / `false`
Default:	`false`
Min SDK	v10.0.0
Supported by:	`showConversation`

using Helpshift;
// other imports

public class MyGameControl : MonoBehaviour
{
    private HelpshiftSdk help;
    void Awake() {
      this.help = HelpshiftSdk.GetInstance();
      help.Install(appId, domainName);
    }

    void OpenHelpshift() {
      Dictionary<string, object> configMap = new Dictionary<string, object>();
      configMap.Add("initiateChatOnLoad", true);
      help.ShowConversation(configMap);
    }
}

UI Configurations

This config represents the theming of Helpshift SDK. For more information check design.

Tracking

This config represents the tracking user actions. For more information check tracking.

SDK Configuration

Install time configurations​

Enable In-App Notifications​

Notification Icon​

Large Notification Icon​

Notification Sound​

Notification Channels​

Enable Logging​

FAQ Filtering by tags​

How to use FAQ filtering​

Conversation prefill text​

Conversation Initial User Message​

Clearing Initial User Message​

Screen Orientation​

Enable Contact Us​

Best Practices​

Full privacy​

Initiate new conversation on chat screen load​

UI Configurations​

Tracking​

Install time configurations

Enable In-App Notifications

Notification Icon

Large Notification Icon

Notification Sound

Notification Channels

Enable Logging

FAQ Filtering by tags

How to use FAQ filtering

Conversation prefill text

Conversation Initial User Message

Clearing Initial User Message

Screen Orientation

Enable Contact Us

Best Practices

Full privacy

Initiate new conversation on chat screen load

UI Configurations

Tracking