Skip to main content

SDK Configuration

Important
Helpshift’s Legacy SDKs (SDK Version <=7.x.x) reached their end of life on 31 Dec 2022, and end of support on 31 March 2023. Please upgrade to the Latest SDK if you haven't already.

SDK Configuration

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

Install time configurations​

enableAutomaticThemeSwitching​

Upon setting this option to true, Helpshift SDK will switch between default light and dark themes based on the OS Appearance setting.

OptionenableAutomaticThemeSwitching
Valuestrue / false
Defaultfalse
Min SDKv3.2.0

Example:


    HelpshiftCore.Initialize(HelpshiftApiProviderType.HelpshiftApiProviderTypeSupport);
    HelpshiftInstallConfig.Builder builder = new HelpshiftInstallConfig.Builder()
    .SetEnableAutomaticThemeSwitching(true);
    HelpshiftCore.Install("YOU_API_KEY", "YOUR_DOMAIN_NAME", "YOUR_APP_ID", builder.Build());

Note
  1. This configuration is only applicable to iOS 13 and above.
  2. Light and Dark Appearance switching works only if your app is built with Xcode 11 or above
  3. If you use SetTheme or SetThemes API, this config takes no effect.

enableInAppNotification​

If you do not want the in-app notification support provided by the Helpshift SDK, you can set the flag to false. The default value of this flag is true i.e., in app notification will be enabled.

FlagenableInAppNotification
Valuestrue / false
Defaultfalse

Example:

HelpshiftInstallConfig installConfig = new HelpshiftInstallConfig.Builder()
                                         .SetEnableInAppNotifications(true)
                                         .Build();
HelpshiftApi.HelpshiftCore.Install("<YOUR_API_KEY>",
                                   "<YOUR_COMPANY>.helpshift.com",
                                   "<YOUR_APP_ID>",
                                   installConfig);

enableDefaultFallbackLanguage​

This option enables or disables fallback to default language that is English for FAQs.

This option enables or disables fallback to default language that is English for FAQs. In case you have FAQs in multiple languages but do not wish to fallback to English if localisation is missing, set this flag to 'false’.

For example if the SDK language is set to French and this option is set to true, then the FAQs for which french translation is available will be displayed in french and for the FAQs for which french translation is not available will be displayed in English. If the value of this option is set to false then the FAQs for French translation will be displayed, and the FAQs for which the translation is not provided will not be displayed at all.

OptionenableDefaultFallbackLanguage
Valuestrue / false
Defaulttrue

Example:

HelpshiftInstallConfig installConfig = new HelpshiftInstallConfig.Builder()
                                         .SetEnableDefaultFallbackLanguage(true)
                                         .Build();
HelpshiftApi.HelpshiftCore.Install("<YOUR_API_KEY>",
                                   "<YOUR_COMPANY>.helpshift.com",
                                   "<YOUR_APP_ID>",
                                   installConfig);
Note

This configuration does not apply to the QuickSearch Bot suggested FAQs.

enableLogging​

Upon setting enableLogging to true, Helpshift SDK logs will be generated in the console. This will be useful for debugging the SDK during integration.

OptionenableLogging
Valuestrue / false
Defaulttrue

Example :


    HelpshiftInstallConfig installConfig = new HelpshiftInstallConfig.Builder()
                                               .SetEnableLogging(true)
                                               .Build();
    HelpshiftApi.HelpshiftCore.Install("<YOUR_API_KEY>",
                                   "<YOUR_COMPANY>.helpshift.com",
                                   "<YOUR_APP_ID>",
                                   installConfig);

disableErrorReporting​

Disables reporting of Helpshift SDK’s internal error logs. The Helpshift SDK will collect internal error logs and report them to our systems to ensure that we become aware of runtime crashes and we have enough information to fix them.

OptiondisableErrorReporting
Valuestrue / false
Defaulttrue

Example :


    HelpshiftInstallConfig installConfig = new HelpshiftInstallConfig.Builder()
                                               .SetDisableErrorReporting(true)
                                               .Build();
    HelpshiftApi.HelpshiftCore.Install("<YOUR_API_KEY>",
                                   "<YOUR_COMPANY>.helpshift.com",
                                   "<YOUR_APP_ID>",
                                   installConfig);
Note

Applicable to version 3.3.0 and above.

API options​

enableContactUs​

The enableContactUs flag controls the visibility of Contact Us button -

Alwaysshow in the navigation bar, search, and after marking an FAQ unhelpful.
AfterViewingFaqsshow only while searching, and after marking an FAQ unhelpful.
Neverdo not show "Contact Us" button anywhere in the SDK.
Option:enableContactUs
Values:HsEnableContactUs.Always / HsEnableContactUs.AfterViewingFAQs / HsEnableContactUs.Never
Default:HsEnableContactUs.Always
Supported by:showFAQs, showFAQSection, showSingleFAQ

Example:

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetEnableContactUs(HsEnableContactUs.AfterViewingFAQs)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, config);

This flag has no effect for the ShowConversation API call, since there is no Contact Us button in the conversation screen.

gotoConversationAfterContactUs​

Note

This API configuration is now deprecated with SDK v3.0.

The gotoConversationAfterContactUs flag will determine whether the user lands up in the conversation screen after starting a new conversation via "Contact Us". This only makes sense if the enableContactUs flag takes on the default value.

OptiongotoConversationAfterContactUs
Valuestrue / false
Defaultfalse
Supported byShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation

Example:

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetGotoConversationAfterContactUs(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);
Note

For ShowFAQs, ShowFAQSection and ShowSingleFAQ, setting gotoConversationAfterContactUs makes sense only if enableContactUs is yes.

requireEmail​

Note

This API configuration is now deprecated with SDK v3.0.

The requireEmail flag will determine whether email is required or optional for starting a new conversation.

When the flag is set to true, customer's email will be required. If set to false, email will be optional.

OptionrequireEmail
Valuestrue / false
Defaultfalse
Supported byShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation
HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetRequireEmail(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);

If "New Issue Forwarding" is ON or if "Allow anonymous issues" is ON in the agent dashboard, then this flag will be ignored.

Note

Once requireEmail flag is set, the SDK will use that value for all new conversations until it is changed again.

hideNameAndEmail​

Note

This API configuration is now deprecated with SDK v3.0.

The hideNameAndEmail flag will hide the name and email fields when the user starts a new conversation.

When the flag is set to true the name and email fields will be hidden. If set to no the default behaviour will resume.

If "New Issue Forwarding" is ON then this flag will be ignored when name and email are not available to the SDK. You can use the SetNameAndEmail API, to supply the SDK with name and email in this case.

If "Allow anonymous issues" is ON, under app settings in the agent dashboard, then this flag will be ignored.

Also, if the requireEmail flag is set to false and email is not available to the SDK, then hideNameAndEmail flag will be ignored.

OptionhideNameAndEmail
Valuestrue / false
Defaultfalse
Supported byShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation
HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetHideNameAndEmail(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);
Note

Once hideNameAndEmail flag is set, the SDK will use that value for all new conversations until it is changed again.

conversationPrefillText​

The conversationPrefillText API option will prefill a new conversation description, with the supplied string. This is useful where you might want your users to send you diagnostic information in the conversation description, for example if the app hits an exception, etc.

OptionconversationPrefillText
ValuesNon-empty string
DefaultEmpty string
Supported byShowConversation

Example:

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetConversationPrefillText("Pre fill text")
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);
Note

The conversationPrefillText option takes effect only for the ShowConversation API

enableFullPrivacy​

In scenarios where the user attaches objectionable content in the screenshots, it becomes a huge COPPA concern. The enableFullPrivacy flag will help solve this problem.

If this flag is set to true, it enables full privacy controls for the SDK. The user can be disabled from attaching screenshots and sending personally identifiable information in meta-data. This helps developers ensure full COPPA compliance.

To send personally identifiable information through custom meta-data, the information must be added inside a dictionary with a "private-data" key. If this flag is set to true, this data will be removed when the user starts a new conversation.

OptionenableFullPrivacy
Valuestrue / false
Defaultfalse
Supported byShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation

Example:

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetEnableFullPrivacy(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, config);
Note
  1. Once the enableFullPrivacy flag is set, the SDK will use that value for all further sessions until it is changed again.
  2. If the enableFullPrivacy flag is set, for SDK versions 2.3.1 or earlier, the email requirement is always set to optional. i.e. even if requiredEmail is true; enableFullPrivacy will override it and set email requirement as optional.
  3. If the enableFullPrivacy flag is set, for SDK versions 2.4.0 or later, the user's 'email and name will not be collected and the fields will be hidden. enableFullPrivacy flag will override all other flags pertaining to name and email field.
  4. For Xamarin SDK v3.0.0 and above, this flag is ignored in the flows created to show Dynamic forms. The following flows do not honor this flag
    • ConversationFlow
    • FAQsFlow
    • SingleFAQFlow
    • FAQSectionFlow

showSearchOnNewConversation​

Note

This API configuration is now deprecated with SDK v3.0.

If showSearchOnNewConversation flag is set to true, the user will be taken to a view which shows the search results relevant to the conversation text that he has entered upon clicking the 'Send' button. This is to avoid tickets which are already answered in the FAQs. The user will still be able to start a new conversation with the same text. He can also go through one of the FAQs and find a solution to his query, and exit the session without submitting a ticket.

Default value is false, ie., this feature will not be enabled unless you explicitly pass true for this flag.

OptionshowSearchOnNewConversation
Valuestrue / false
Defaultfalse
Supported byShowFAQs, ShowFAQSection, ShowSingleFAQ, ShowConversation

For example:

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetShowSearchOnNewConversation(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);
Note

The showSearchOnNewConversation option takes effect only for the showConversation API.

showConversationResolutionQuestion​

Note

This API configuration is now deprecated with SDK v3.0.

This option enables or disables the showing of the Conversation Resolution view after an Agent has marked an Issue resolved. Conversation Resolution is added to the bottom of the screen with a Yes and No button. If the user taps Yes, then this view is replaced with a Start a new conversation view. If the user taps No, then we dismiss the Conversation Resolution view and let them continue the conversation.

For v3.0 and above:

This SDK configuration is deprecated with v3.0+ and default value will be treated as false.

If you want to use this feature, you can turn the feature on and off Resolution Question from the in-app configuration page. Settings > App settings

Older SDKs will keep on working with the expectations mentioned below:

For older SDK versions v2.x and below, please read the following:

This option is set to true by default, which means that the user will be presented with Conversation Resolution view. If you wish to skip this view then the option needs to be set to false.

FlagshowConversationResolutionQuestion
Valuestrue / false
Defaultfalse

Example :

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetShowConversationResolutionQuestion(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);

customContactUsFlows​

FlagcustomContactUsFlows
ValuesList of Flows. See the example below to create flows.
DefaultThere is no default value for this configuration.

This configuration allows you to override the Contact Us buttons inside the Helpshift SDK and show Guided Issue Filing when a user taps on the Contact Us buttons.

Example :

Let’s say you want the users to see a particular FAQ section, a single FAQ and 2 different Contact Us flows with different prefill texts when they tap the Contact Us buttons within the Helpshift SDK. In this case, you would configure the showHelp button (a button which triggers Helpshift SDK) in the following way :

FAQSectionFlow faqSectionFlow = new FAQSectionFlow("1509", "FAQ section");
SingleFAQFlow singleFAQFlow = new SingleFAQFlow("2998", "FAQ");
HelpshiftAPIConfig conversationConfig1 = new HelpshiftAPIConfig.Builder()
                                          .SetConversationPrefillText("Contact Us about our app")
                                          .Build();
ConversationFlow conversationFlow1 = new ConversationFlow("Converse 1", conversationConfig1);
HelpshiftAPIConfig conversationConfig2 = new HelpshiftAPIConfig.Builder()
                                 .SetConversationPrefillText("Contact Us about in-app purchases")
                                 .Build();
ConversationFlow conversationFlow2 = new ConversationFlow("Converse 2", conversationConfig2);
IList<Flow> flows = new List<Flow>() { faqSectionFlow, singleFAQFlow, conversationFlow1,
                                       conversationFlow2 };

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetCustomContactUsFlows(flows)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, config);

Anytime the Helpshift SDK is presented via showHelp with this configuration, the Contact Us buttons in the SDK will redirect to Guided Issue Filing with the flows provided in the customContactUsOptions list.

Once a particular flow is selected, the subsequent Contact Us buttons will redirect to nested customContactUsFlow if configured else to default contact us screen.

Custom flows can be nested by passing another custom flows configuration while creating a flow.

Example :

Let’s say you want to configure singleFAQFlow in the above example to show showConversationFlow1 and showConversationFlow2 through the Contact Us buttons inside it. In this case, you would configure the showHelp button (a button which triggers Helpshift SDK) in the following way :

HelpshiftAPIConfig conversationConfig1 = new HelpshiftAPIConfig.Builder()
                                          .SetConversationPrefillText("Contact Us about our app")
                                          .Build();
ConversationFlow showConversationFlow1 = new ConversationFlow("Converse 1", conversationConfig1);
HelpshiftAPIConfig conversationConfig2 = new HelpshiftAPIConfig.Builder()
                                 .SetConversationPrefillText("Contact Us about in-app purchases")
                                 .Build();
ConversationFlow showConversationFlow2 = new ConversationFlow("Converse 2", conversationConfig2);
IList<Flow> nestedFlows = new List<Flow>() { showConversationFlow1, showConversationFlow2 };
HelpshiftAPIConfig singleFAQConfig = new HelpshiftAPIConfig.Builder()
                                         .SetCustomContactUsFlows(nestedFlows)
                                         .Build();
SingleFAQFlow singleFAQFlow = new SingleFAQFlow("2998", "FAQ", singleFAQConfig);
FAQSectionFlow faqSectionFlow = new FAQSectionFlow("1", "FAQ Section");
IList<Flow> flows = new List<Flow>() { singleFAQFlow, faqSectionFlow };

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetCustomContactUsFlows(flows)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, config);

With this configuration, the Contact Us buttons in singleFAQFlow View will redirect to Guided Issue Filing with showConversationFlow1 and showConversationFlow2.

showConversationInfoScreen​

Note

Applicable to version 2.3.1 and above.

The showConversationInfoScreen flag will determine if the user can see the Conversation info on the conversation feed. If set to true, the Conversation ID (Issue ID) will be shown in conversation feed.

FlagshowConversationInfoScreen
Valuestrue/false
Defaultfalse

Example :

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetShowConversationInfoScreen(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowConversation(activity, config);
Note

The Conversation ID (Issue ID) will only be visible when a conversation is actually created for support teams and Automations / Agents can act on it. (This is after QuickSearch Bot (if configured) and Identity Bot (if configured) complete their tasks.)

enableTypingIndicator​

Note

Applicable to version 2.4.0 and above.

A graphical indicator is shown to the end user if an agent is currently replying to the same conversation. The "enableTypingIndicator" flag will enable/disable this indicator.

This SDK configuration has been deprecated, since this configuration has shifted to the In-App SDK Configurations page. (Settings > App settings)

For SDK v3.0 and above, the typing indicator configuration Show Agent Typing Indicator is now part of the In-app SDK Configurations page.

If this configuration is turned ON from the configurations page OR if the SDK configuration is used, then the typing indicator will shown to end users.

Older SDKs will keep on working with the expectations mentioned below:

For older SDK versions between v2.4.0 to v2.6.0, please read the following:

FlagenableTypingIndicator
Valuestrue/false
Defaultfalse

Example :

HelpshiftAPIConfig config = new HelpshiftAPIConfig.Builder()
                                         .SetEnableTypingIndicator(true)
                                         .Build();
HelpshiftApi.HelpshiftSupport.ShowFAQs(activity, config);
Note

The typing indicator will be visible to end users who file new issues using v2.4+ SDKs

IssueDescriptionMinimumCharacterLength​

To control the minimum number of characters that the users need to type before they can start a conversation, use this option and set it to an appropriate integer value. This option works both in Conversational issue-filing and Form-based issue-filing experience. Since this option is dependent on the language in which the user starts a conversation, developers are encouraged to set this value for each language as appropriate.

Note

This option is not an SDK API config but rather a key in the HelpshiftLocalizable.strings file.

Configuration Summary​

Configuration / APIshowFAQsshowFAQSectionshowSingleFAQshowConversation
enableContactUsSupportedSupportedSupportedNot Supported
gotoConversationAfterContactUsSupportedSupportedSupportedSupported
presentFullScreenOniPadSupportedSupportedSupportedSupported
requireEmailSupportedSupportedSupportedSupported
hideNameAndEmailSupportedSupportedSupportedSupported
conversationPrefillTextNo effectNo effectNo effectSupported
enableFullPrivacySupportedSupportedSupportedSupported
showSearchOnNewConversationSupportedSupportedNo effectSupported
showConversationResolutionQuestionSupportedSupportedSupportedSupported
customContactUsFlowsSupportedSupportedSupportedNot Supported
showConversationInfoScreenSupportedSupportedSupportedSupported
enableTypingIndicatorSupportedSupportedSupportedSupported