Looking for older SDK 3.X docs? Click here →

Release Notes

7.3.0 Download SDK

October 3, 2018

Release Notes

  • Added iOS 12 support.
  • Applications are now required to build with Xcode 10.0 and above.
  • Added Campaigns delegate callbacks for tracking when a Helpshift session begins and when a session ends. Details are available here
  • Added new customization keys. Details are available here
    • Selectable Option Text Color: The color of the text in option pills of the Answer Bot or skip button.
    • Selectable Option Background Color: The background color of the option pills of the Answer Bot or skip button.
    • Selectable Option Border Color: The border color of the option pills of the Answer Bot or skip button.
    • Field Background color: The background color of the reply field.
    • Field border color: The border color of the reply field.
  • Removed the selectable option color customization key. Please use the latest plist with the updated keys if you plan to customize the Helpshift UI.
  • Introduced the ability for users to open user-sent attachments.
  • Fixed a bug where Custom Bot options were only partially rendered in the chat screen.
  • Fixed a bug where the new conversation button was shown along with the reply box.
  • Fixed a bug where the conversation screen was not scrolling to the bottom when the option pills were rendered.
  • Fixed a bug where the conversation would get closed when the chat screen was partially slid from the left.
  • Fixed a bug where the greeting message text was appended whenever the chat screen was partially slid from the left.
  • Fixed a bug where the app would crash when the chat screen was partially slid from the left after the user had tapped on the new conversation button.
  • Fixed a bug where Custom Bots pills were not rendered on migration,
  • Fixed a bug where the reply box was not shown when a New Issue Automation was enabled with Custom Bots and an action set to resolve the Issue.
  • Fixed a bug where the new conversation button was not shown after the user had selected one of the options offered by Answer Bot.
  • Fixed a bug where the app would crash after the chat screen was scrolled while the user was in the process of selecting a Custom Bot option pill.
  • Fixed a bug where Admin attachments were not displayed in the chat screen when a screenshot request was sent with an attachment.
  • Fixed a bug where the app would crash after the user had tapped on the New Conversation button when conversations history and a greeting message were both disabled.
  • Fixed the alignment of the pill options and the skip button.
  • Fixed a bug where Answer Bot option pills were still visible when they weren't supposed to be in some edge cases.
  • Fixed a bug where the user attachment button was not showing in the chat screen after a user had rejected the resolution question.
  • Fixed bug where the new conversation button would jump up when the orientation was changed from landscape to portrait.

7.2.0

August 21, 2018

Release Notes

  • Introduced functionality for end users to view their past conversations. This can be managed via an Admin toggle available in the Dashboard on the App settings > the In-app SDK configuration page. Review this FAQ to get started.
  • Introduced functionality for Admins to prevent users from being able to attach files in conversations. This can be managed via an Admin toggle available in the Dashboard on the app settings > the In-app SDK configuration page.
  • Introduced a new way to embed messaging experience in your iOS app. Details are available here.
  • Fixed an edge case bug where, if the end user sent an image attachment at the same time that the Agent rejected the Issue, the Issue would remain open on the end user side.
  • Fixed a crash that would occur on 32 bit devices when the user selected a date in response to a Custom Bot.
  • Fixed a crash that would occur when accessing a dictionary in a multithreaded environment
    • Stack trace: [__NSDictionaryM setObject:forKey:]
      [HsIOSNetworkRequestDAO storeEtag:forRoute:]

7.1.1

July 25, 2018

Release Notes

  • Fixed a bug wherein all the options in an options list sent by Custom bot would not be rendered the first time it appeared when the app was in landscape mode. Selecting an option in this partially rendered list would crash the application.

7.1.0

July 10, 2018

Release Notes

  • Introduced support for Custom Bots.
  • Fixed a bug where the system kept the form-based Issue filing experience as the default if the Conversational Filing configuration from the Dashboard was not known to the SDK yet.
  • Fixed a bug where the SDK was incorrectly reporting the build number as the application version while filing the issue.
  • Fixed a bug where image attachments sent by an end user were not re-fetched after they had logged out and logged back in.
  • Fixed a bug where image drafts were lost in the form-based Issue filing experience when the user visited suggested FAQs.
  • Fixed a bug where image attachments sent by the end user were uploaded twice when network timeout errors occurred.
  • Fixed a bug where the SDK was not throwing the InstallException in cases where wrong install credentials were provided.
  • Fixed a bug where the name field was not being updated when the same user logged in with a different name.
  • Fixed a bug where the dark theme was incorrectly displayed on iPhoneX devices in the FAQ detail screen bottom view.
  • Fixed a bug where the status bar color property was not reflected correctly the first time that the screen was launched.
  • Fixed a bug where the send button image theme could not be edited.
  • Fixed a bug where the SDK was not considering the current push permission status with regards to starting and stopping the poller.
  • Fixed a bug where FAQ search results were not being highlighted for CJK languages.
  • Fixed a bug where pending notifications for a closed Issue were taking the user to the chat screen of the closed Issue even after the user had already created a new Issue.
  • Fixed a crash that would occur rarely while retrying the failed network requests:
    • Stacktrace: objc_class::demangledName(bool) NSStringFromClass +[HSConstants queueNameForClass:]
  • Fixed a crash in database operations:
    • Stacktrace: __hs_db_worker_queue +[HsDbUtil pathForDatabaseName:] +[HsDbUtil openDb:] + 4342041624

7.0.1

May 9, 2018

Release Notes

  • Fixed a bug where network requests were not automatically retried when failures occurred.
  • Fixed a bug where FAQs did not load for some users when upgrading to 7.0.0.
  • Fixed a crash that would occur in cases where a user replied to a Rejected conversation.
  • Fixed a rare bug where a user might get stuck in pre-issue state.
  • Fixed a bug where the 'didReceiveInAppNotification' delegate was not called in some cases.
  • Fixed a bug where a user would see a blank screen when the showConversation API was called.
  • Fixed a CFBundleExecutable key Issue in bundles.
  • Fixed a bug where the pre-Issue state might be reset when an app reinstall occurred.
  • Fixed a bug where in some cases, the badge count would not update on FAQ screens.

7.0.0

April 23, 2018

Release Notes

  • Introduced new updates to the in-app messaging experience. Here's our guide on how to onboard to the new experience. View
  • Introduced a new and enhanced Login API for managing the name, email, and user identifiers for your end users. View.
  • Introduced the ability to use the 'Email' field as a means of identifying users, so that email addresses don't have to be passed to the 'User ID' field.
  • Introduced 'user auth token', which is an HMAC Digest used to ensure that the requests are coming from an authentic source (and not a malicious 3rd party). View
  • Introduced the Answer Bot and Identity Bot for in-app messaging SDKs.
  • Enhanced UI and support for voiceover.
  • SDK screens are not orientation locked anymore.
  • Chat bubble colors are customizable now.
  • Deprecated the setNameAndEmail(), setUserIdentifier() and the existing loginWithIdentifier: APIs. Please use the new login API.
  • Deprecated the configurations conversationPrefillText, requireEmail, hideNameAndEmail, goToConversationAfterContactUs, showSearchOnNewConversation along with the Form-based Issue filing experience. All the details are mentioned here
  • Dropped support for iOS8 and below.
  • Fixed cases where multiple Issues can be created or duplicate messages can be sent from the SDK in case of client network errors.
  • Fixed a bug where FAQ search keywords specified on the Dashboard were not picked up by the SDK if they contained capital letters.
  • Fixed a bug where users wouldn't receive push notifications if the push token syncing failed.
  • Fixed a bug where sometimes the SDK would keep making network requests if the host app is executing a background operation.
  • Fixed a bug where, on the Issue filing screen, a deleted description draft would reappear after attaching the screenshot.
  • Fixed a bug where the 'Contact Us' button was not visible if the FAQ or Section title was too large.
  • Fixed a bug where the bottom half of the in-app notification banner was not tappable on an iPhone X.
  • Fixed a bug where the background of the table view when presenting FAQ search results was not styled properly in Dark theme.
  • Fixed a bug where sometimes a chat screen will launch automatically when multiple in-app notifications were received at the same time.
  • Fixed a bug where sometime users were able to give a CSAT rating after they had reject the resolution request.
  • Fixed a bug where the users' device was shown as an iPhone 7 instead of an iPhone 7 plus.
  • Fixed a bug where user engagement analytics were not properly captured for Campaigns push notifications.
  • Fixed a bug where rich push notification actions were not working in Campaigns push notifications if the UNNotification framework was used.
  • Fixed a bug where the badge count for unread messages on the FAQ screen was incorrect if the Issue was resolved and the app was killed and re-opened.
  • Fixed an issue where the SDK was throwing and catching exceptions while the device is offline, making the offline debugging harder for developers.
  • Fixed a crash in database operations.
  • Stacktrace: thread #4, queue = 'com.helpshift.HSIssuesPersistentStorage', stop reason = EXC_BAD_ACCESS (code=1, address=0x74786574)
  • Fixed a crash which would sometime occur when sanitizing the user name string.
  • Stacktrace: NSInvalidArgumentException
    • [HSProfile initWithServerIdentifier:identifier:name:email:userId:deviceId:andLastSeenAt:isSynced:]
  • Fixed a crash which would occur when syncing device data for Campaigns:
    • Stacktrace: NSInvalidArgumentException [HsDeviceController makeHSRequestForProperties:]

6.4.3

February 13, 2018

Release Notes

  • Fixed a rare edge case where users were not able to send or receive messages.
  • Improved Helpshift's podspecs to address an issue where test targets were not building after Helpshift's pod integration.

6.4.2

January 16, 2018

Release Notes

  • Fixed a rare crash that would occur when the SDK configuration was being fetched for the first time.
    • Stack trace: 0x00000001903ae2d0 -[__NSDictionaryM setObject:forKey:] + 320 0x0000000100157ee8 -[HsSdkInfoModel addEtag:forRoute:] + 136

6.4.1

December 21, 2017

Release Notes

  • Fixed a bug where symbols were conflicting with SocketRocket while using -all_load linker flag.
  • Fixed a race condition where the SDK stopped fetching new messages after navigating to the chat screen from FAQs.
  • Fixed a rare bug where agent typing indicator would not be visible to the user.
  • Fixed a rare crash while storing campaigns sessions.
    • Stack trace:Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: '*** -[__NSPlaceholderArray initWithObjects:count:]: attempt to insert nil object from objects[1]'
  • Fixed a crash when the entered text in FAQs Search Controller was in auto-correct/suggestion mode and user pressed cancel.
    • Stack trace: -[__NSPlaceholderDictionary initWithObjects:forKeys:count:]: attempt to insert nil object from objects[0] in method -[HsFaqSearchUIControllerImpl addFAQAnalyticEvent:]

6.4.0

November 20, 2017

Release Notes

  • Added support for iPhoneX.
  • Applications are now required to build with Xcode 9 so that layouts work correctly across all supported iOS versions. If you have an XCode 8 project, you could use the build mentioned here.
  • Added support for UNNotifications framework for push notifications. View
  • Improved the accessibility behavior for the following UI elements:
    • Resolution Request view
    • "Start a new conversation" button
    • Customer Satisfaction Survey flow
    • Failed message indicator view
    • "Screenshot Request" message
    • "Review Request" message
    • Automation reply message
    • Attachment message
  • Improved Italian translation for "Email (optional)" string.
  • Fixed a crash in the Campaigns login API .
    • Stack trace: [HsSwitchUserController getRequestData] setObjectForKey - object cannot be nil (key: uid)
  • Fixed a crash in the SDK migration flow.
    • Stack trace: setObjectForKey: object cannot be nil (key: profile-id)
  • Fixed a crash in the Campaigns property syncing.
    • Stack trace: Exception: NSInvalidArgumentException in -[HsUserModel setSyncStatus:forProperties:]
  • Fixed a crash which would occur when the showDynamicFormOnViewController:withTitle:andFlows:withConfig: API was called.
  • Fixed a bug where the chat screen would automatically open if the control center or notification tray was open at the time of push notification arrival.
  • Fixed an edge case bug where users would see a blank chat screen if they filed a new conversation while the SDK was migrating to a new SDK version.
  • Fixed a bug where the image attachment would flicker after being sent successfully.
  • Fixed a bug where the typing indicator animation was not smooth on iOS 11 devices.
  • Fixed a bug where the "Contact Us" button in the search footer was not localized for VO users.
  • Fixed a bug where focusing on the tableview in VO mode would shift the tableview down and show some empty space on top.
  • Fixed a bug where Bar button font name was not getting applied from the HelpshiftConfigDark.plist.
  • Fixed a bug where font size in Table Section Header was not getting applied.

6.3.1

November 13, 2017

Release Notes

  • Fixed a UX issue for apps built with Xcode8 or prior and running on iOS11 where the beginning of the tableviews was shifted down.

6.3.0

October 13, 2017

Release Notes

  • Added support for sending "Custom Issue Fields" when filing a new conversation. View
  • Added a Swift compatible API to send logs when filing a new conversation. View
  • Added support for passing 64 bit integers in campaigns user properties. View
  • Added an API to asynchronously request unread campaigns message count. View
  • Added a new delegate to provide unread campaign message count. View
  • SDK now requires -ObjC flag to be present in the "Other Linker Flags" under Build Settings section. View
  • Made improvements to the Campaign images downloading mechanism.
  • Fixed an intermittent crash on conversation filing screen when network is unavailable.
  • Fixed a bug where links were not working in Screenshot Request messages.
  • Fixed a UI issue where calling UIAppearance proxy API to invoke setContentInsetAdjustmentBehavior from host app was affecting SDK's scroll views.
  • Fixed a bug where Application state was being read from background thread instead of main thread.
  • Fixed an accessibility bug where VO would navigate to "Describe your problem" text view and its placeholder in the text input area.
  • Fixed a rare case where failing to read metadata of a message from disk could cause the app to crash.
  • Improve accessibility VO label for "Send" button on Conversation Filing Screen.
  • Improved handling of the rare case where Conversation DB could go in undesirable state.
  • Deprecated the following APIs. View
    • (void) log:(NSString *)format, ...; in HelpshiftSupport class
    • (NSInteger) getCountOfUnreadMessages in HelpshiftCampaigns class

6.2.0

September 22, 2017

Release Notes

  • Helpshift now supports iOS 11
  • Deprecated showAlertToRateAppWithURL:withCompletionBlock: API. An explanation of why we made this change can be found here.
  • Automatic review reminder requests sent from the backend will now be ignored.
  • Updated the review action in Campaigns to have it redirect to the app store page of the app.
  • Fixed some code comments.
  • Make method didReceiveNotificationCount in HelpshiftSupportDelegate optional. Use the newer requestUnreadMessagesCount/didReceiveUnreadMessagesCount APIs instead.
  • Fixed a bug where the color set using "Rating star color" was not being applied to stars on feedback screen.
  • Fixed Hindi translation for "You found this helpful" string.
  • Fixed a rare crash in signature generation while making a network request.
  • Fixed a bug where the retry button for text messages would not work even after reconnecting to the network.

6.1.0

August 21, 2017

Release Notes:

  • Added support for iOS-11 beta-5
  • Added a new API to set the SDK language asynchronously. View
  • Added an API to asynchronously check if an active Conversation exists. View
  • Added an API to asynchronously request unread message count. View
  • Added an API to asynchronously create and return dynamic form for given flows. View
  • Added the following methods to the HelpshiftSupportDelegate protocol:
    • (void) didCheckIfConversationActive:(BOOL)isActive
    • (void) didReceiveUnreadMessagesCount:(NSInteger)count
    • (void) didCreateDynamicForm:(UINavigationController *)form
  • Setting enableFullPrivacy API configuration to true will now hide name and email address fields. View
  • Fixed a bug where blank cells appeared upon searching for FAQs in FAQ section view.
  • Fixed a bug on iOS 11-beta where the text view to enter CSAT review text was not visible in review rating screen.
  • Fixed a bug where compilation would fail if Socket Rocket library was integrated with the app through source code.
  • Fixed a bug where tags were not added to the new issue if added without metadata.
  • Fixed a bug where "Bold font name" config was not applied to FAQ title.
  • Fixed a bug where the applications that use Google Cast SDK would crash while filing a new Conversation.
  • Fixed the warnings reported by Xcode 9 where some of the UIKit APIs were called from secondary thread.
  • Fixed a bug where database connections were not closed before removing the database during migration.
  • Fixed a bug on iOS 11 where back button title would not appear in single FAQ and Conversation screens.
  • Deprecated the following APIs within the HelpshiftSupport class: View
    • (BOOL) isConversationActive
    • (NSInteger) getNotificationCountFromRemote:(BOOL)isRemote
    • (UINavigationController ) dynamicFormWithTitle:(NSString )title andFlows:(NSArray *)flows
    • setSDKLanguage:(NSString *)languageCode
  • Deprecated the method (void) didReceiveNotificationCount:(NSInteger)count in HelpshiftSupportMetadata protocol. View

6.0.0

July 18, 2017

Release Notes:

  • Added compatibility for iOS 11 beta 3.
  • Added support to show an animated indication on the Conversation screen when an Agent is replying to the Conversation.View
  • Added a new High Contrast theme.View
  • Added two new keys for customizing text color of the user chat bubble and Agent chat bubble.View
  • Added new key for customizing Typing indicator color.View
  • Added new keys for customizing Secondary text color, Placeholder text color and Timestamp text color.View
  • Removed Helpshift class and all its member methods that were deprecated in SDK version 5.0.0.View
  • Deprecated APIs that take install and API configurations as NSDictionary.View
  • Fixed a bug where the SDK would crash upon pressing the back button after attaching a second screenshot while the first screenshot upload was still in-progress.
  • Fixed a bug where the SDK would crash if the Issue was filed with a corrupt image.
  • Fixed a bug where the SDK would crash upon calling setMetadataObjectBlock API.
  • Fixed a bug where the search title text was not highlighted in search results.
  • Fixed a bug where the FAQ footer text got clipped if the font size was increased in the device's accessibility settings.
  • Fixed a bug where follow-up was successful if sent while the user was typing.
  • Fixed a UI glitch where extra padding was added to the table view search controller if the translucency of the navigation bar was disabled.
  • Fixed bug where a crash would occur when multi-character UTF-16 encoded characters were found in the FAQ body of search results.
  • Fixed a bug where the Contact Us button in FAQ search results list was not accessible via the accessibility identifier.
  • Fixed a bug where the badge count was not updated when the Issue was resolved.
  • Fixed a bug where notification count APIs were returning incorrect values.
  • Fixed a bug where the app was not suspended immediately after being backgrounded.
  • Fixed a bug where a crash would occur on iOS 11 beta 3 while attaching a screenshot in new Conversation.
  • Fixed crash on some devices in rare cases while creating a new issue.
  • Fixed a rare bug where a crash would occur on syncing sessions on iOS 10.
  • Fixed a rare crash on app launch.
  • Improved syncing server configurations.
  • Improved handling for failed network requests.

5.10.1

April 18, 2017

Release Notes:

  • Added new SDK configuration for showing conversation info screen. View
  • Fixed getActionTitleColor API returning title instead of title color.

5.10.0

March 31, 2017

Release Notes:

  • Introduced a new API that helps redirect users directly to Conversation on tapping of push notification in cases where the app was killed by the user. View
  • Added new SDK configuration debug logging in the SDK for solving Issues during integration. View
  • Added an API to check if there is an active conversation. View
  • Added a delegate method that lets the app know when a Conversation has ended. View
  • Added Inbox Data APIs to retrieve 'action type' and 'action data' for Campaigns action buttons in messages. View
  • Made image attachment upload more network-efficient, also added support for GIF type images.
  • Added validation to guard against malformed FAQ and Section IDs.
  • Users can now view their Issue ID for an ongoing Issue by navigating to the Issue Information Screen by tapping the icon on the top-right of the Conversation screen.
  • Added a configuration in HelpshiftConfig.plist to specify extra vertical padding for table view cells.
  • Added a configuration in HelpshiftConfig.plist to hide the label of the back button while Helpshift session is active.
  • Added a configuration in HelpshiftConfig.plist to specify file name for custom font for FAQ body and custom bold font for FAQ title.
  • Added translations for the screenshot tutorial.
  • Replaced UIWebView implementation with WKWebView to display HTML content of an FAQ.
  • Improvements to voice over support.
  • Fixed a bug where row height was not being calculated correctly for FAQ tables.
  • Fixed a bug where a failed message delivery could be re-sent multiple times.
  • Fixed all memory leaks.
  • Fixed an edge case where in some rare cases an Agent message was not visible to the user.
  • Fixed a bug where a user's keyboard was dismissed after 'report new Issue view controller' is dismissed.
  • Fixed a bug where the FAQ view did not use the system default font.
  • Fixed a bug where chat bubble for landscape images was not on the same aspect ratio.
  • Fixed a UI issue where description text could overlap a button in certain cases.
  • Fixed a UI issue where the Helpshift SDK would hide the status bar even if the app displays it.
  • Fixed an issue with the loading spinner for image downloads being shown indefinitely in cases of no network detection.
  • Added missing device names to the device map dictionary.
  • Fixed bug where in some rare cases, conversation resolution question is displayed when an agent sends a follow up request.
  • Fixed a bug that prevented the Close button from functioning correctly in some cases.
  • Fixed a bug where some alert popups could move to a buggy position on screen in cases when SDK was launched on push notifications.
  • Fixed a bug in follow up feature where a follow up request from Agent fails in some valid cases.
  • Fixed a bug where customer could reopen a resolved issue by attaching an image.
  • Fixed a bug where some UI elements were not correctly using the theming options.
  • Fixed an issue where user could launch multiple conversation screens by tapping repeatedly on Contact Us buttons.
  • Fixed a bug where conversation text typed by customer could get deleted in some cases where he attempts to attach an image with it.
  • Fixed a bug where agent name is not shown for follow up request message.
  • Fixed a bug where a user can accept or reject issue resolution multiple times in some cases.
  • Fixed a case where chat screen was relaunched if the user was previously on chat screen and received a support push notification.
  • Fixed a bug where in some rare cases the “Ok, Attach” button was still visible after user attaches a screenshot.

5.9.3

February 6, 2017

Release Notes:

  • Fixed a bug where in rare circumstances FAQs would not load.

5.9.2

February 2, 2017

Release Notes:

  • Fixed a crash when Send Feedback button is tapped on the periodic review reminder alert view.
  • Fixed bug where an empty view controller was shown after quickly tapping the back button twice on the report issue screen or the chat screen.

5.9.1

January 18, 2017

Release Notes:

  • Fix bug where the SDK didn't pick up device language if it is Chinese - Hong Kong (Traditional) on iOS 8.x and iOS 9.x.

5.9.0

January 10, 2017

Release Notes:

  • Added support for setting expiry time to campaign messages.
  • Implemented custom logger to support debug logs.
  • Improved in-app FAQ search by making it faster and memory efficient.
  • Helpshift SDK now supports iOS accessibility features for dynamic type sizes.
  • Fix and issue where FAQ with search tags were not prioritised correctly in the search results.
  • Improved translations for SDK strings.
  • Helpshift SDK now supports two more Chinese dialects: 'Chinese - Hong Kong' and 'Chinese - Singapore'.
  • Fix in-app notifications not received for issue resolution.
  • Fix in-app notifications do not support orientations of the topmost view controller onto which they are shown.
  • Fix in-app notifications rotate even if the app does not support rotation.
  • Fix application version is not retrieved from main bundle.
  • Fix app crashes when attempting to attach a file with no extension.
  • Fix if an UIAlertView with textfield is presented with the app in the landscape mode, it goes beneath the onscreen keyboard.
  • Fix when entering a very long name into the conversation page the name starts to overrun the email section before it gets truncated.
  • Fix campaigns are fetched after a delay if a campaign is pushed through push notification but and user launches the app manually.
  • Fix top level domain of the e-mail address (Issue reporter email) can't take more than 4 letters.
  • Fix SDK asking for push permissions on behalf of the app even if app is registered for silent push.
  • Changed the logic for handling http failures from the helpshift servers.
  • Fix issue where Helpshift SDK used to poll even when push was enabled.
  • Fix FAQs not getting added to Core Spotlight if the configuration is changed from HsAddFaqsToDeviceSearchNever to HsAddFaqsToDeviceSearchOnInstall.
  • Improved Syncing strategy for campaigns data.

5.8.0

September 30, 2016

Release Notes:

  • Added support for iOS 10.
  • Fix for iOS 10: An issue where the App Rating popup presented by Helpshift could move to an incorrect position.
  • Added HelpshiftAPIConfig and HelpshiftInstallConfig APIs to simplify SDK configs.
  • SDK no longer includes the 'carrier name' in metaData if 'enableFullPrivacy' flag is set to true.
  • Push campaigns are now registered on first launch.
  • Fix automatically close Helpshift’s campaign UI in case a deeplink action links back to the same app.
  • Fix memory leak caused by Helpshift SDK holding a strong reference to the host app’s viewController.
  • Fix an issue with Guided Ticket Filing where pressing back button would sometimes take the user to a blank screen.
  • Fix an issue where if an FAQ contains an animated GIF, sometimes the user will get multiple failed messages error.
  • Change the name of campaigns inbox delegate (from notificationDelegate to hsInboxNotificationDelegate) to avoid name conflict with Apple’s private API.
  • Fix an issue where the table row text for a FAQs could be truncated with ‘…’ for some languages.
  • Fix an issue where chat screen could go blank when returning from Suggestions view.
  • Fix as issue where Helpshift logo could sometimes be visible on Chat screen.
  • Updated voice over labels on Single FAQ screen.

5.7.1

August 24, 2016

Release Notes:

  • Fix accessibility VoiceOver labels in the SDK.

5.7.0

August 18, 2016

Release Notes:

  • Support Issue Archival feature which will automatically archive issues which are in Resolved or Rejected state for more than 12 months.
  • Add strict validation for HelpshiftCore's installForApiKey:domainName:appID: API. This API will now throw Install Exception if there are validation issues in the key information.
  • Move the Helpshift's localization files to HsLocalization.bundle file. For instructions on how to customize Helpshift strings, please visit https://developers.helpshift.com/ios/string-customization/
  • Add support for customizing Helpshift themes using a HelpshiftCustomConfig.plist file. For more details, please visit https://developers.helpshift.com/ios/design/
  • Handle corrupt or unsupported file formats in In-App Campaigns.
  • Improve localizations for German, Dutch, Chinese and Korean languages.
  • Fix resource deadlocks in Campaigns code.
  • Fix warnings in Helpshift header files.
  • Fix a bug where user was able to say Yes/No to resolution request multiples times on SDK upgrade.
  • Add support for handling HTML entities in FAQ search.
  • Add support for iOS 10 Beta release.
  • Fix for iOS 10: Crash when navigating to a Single FAQ.
    1. Open FAQ sections (showFAQs:)
    2. Tap any FAQ
    3. User is taken to Single FAQ screen and app crashes.
  • Fix for iOS 10: Crash when an in-app notification is displayed.
    1. File an issue
    2. Exit Helpshift
    3. Reply to ticket from dashboard
    4. An in-app notification is shown and the app crashes.

5.6.2

July 27, 2016

Release Notes:

  • Fix crash in FAQ search if any of the FAQ search tags starts with a special character.

5.6.1

June 3, 2016

Release Notes:

  • Remove duplicates in Localization files.
  • Fix crash in showFAQs API when there is only 1 section with some FAQs.
  • Impact analysis of version 5.6.1 remains same as 5.6.0

5.6.0

May 18, 2016

Release Notes:

  • Show notification to the user when agent resolves a conversation.
  • Send user-id and device-id with every new conversation to facilitate integration of the Support and Campaigns products.
  • Fix bug which caused warnings about setting UI properties from background thread.
  • Add translations for Bengali, Bulgarian, Gujarati, Hindi, Kannada, Latvian, Malayalam, Marathi, Punjabi, Persian, Tamil and Telugu languages.
  • Fix bug which prevented keyboard from dismissing on some UI screens.
  • Fix conversation state mismatch where user is able to click Yes and No multiple times when presented with a resolution question.
  • Improve localization strings according to customer feedback.
  • Added Voice over support in the SDK for improving Accessibility.

  • Impact analysis

5.5.1

April 4, 2016

Release Notes:

  • Fix compiler error when all_load linker flag is enabled.
  • Fix : Remove the CFBundleExectuable key from HsUIResourceBundle.
  • Update French translations.

5.5.0

March 17, 2016

Release Notes:

  • Add support for Inbox functionality and rich in-app campaign messages.
  • Add config option for supporting Guided Issue Filing when user clicks on Contact Us from inside the SDK screens.
  • Fix a bug that prevented config to be fetched after migration. This caused new SDK version to use incorrect values for certain configuration items.
  • Fix a bug that caused text within individual chat bubbles to be scrollable. This prevented the chat screen from scrolling properly.
  • Add support for sending messages read status from the SDK.
  • Reduce init times of the Helpshift SDK by adding async queuing mechanism.
  • Fix API config behaviour for flags not passed in the API.
  • Fix showSingleFaq API call behaviour which caused FAQ to not get updated on migration.
  • Add support for all dialects of Danish and Norwegian languages.

  • Impact analysis

5.3.0

December 16, 2015

Release notes:

  • Add a way for View controller based status bar apps to set Helpshift status bar style.
  • Add support for iPad Slide Over and Split View.
  • Fix an issue where the in-app notification bar appeared in the wrong orientation on some devices.
  • Improve the way copy text features works on chat screen.
  • Fix an issue that caused images on FAQ screen to not load when launched from spotlight or deep-link.

5.2.1

November 9, 2015

Release notes:

  • FIX Sending of screenshots was failing on iOS 9 due to ATS restrictions.
  • FIX Default values being set incorrectly in case the config options dictionary was nil.

5.2.0

November 6, 2015

Release notes:

  • Fix: When using theming via HelpshiftConfig.plist file, there was a bug which prevented setting the navigation button colours.
  • Added support for copy/pasting messages in chat screen. Now you can long-press a message to bring up the copy menu.
  • Updated accessibility strings for some UI elements.
  • Added a flag to disable entry and exit animation for Helpshift screens. Only applicable to the launch and close events of Helpshift Support views. Animations will still be present inside a Helpshift Support session.

5.1.0

October 30, 2015

Release notes:

  • Added feature for Guided issue filing for all support issues created by the end-user.
  • New SDK option for improving ticket deflection. Added option for CONTACT_US_AFTER_MARKING_ANSWER_UNHELPFUL to show contact us only after end user marks a FAQ unhelpful.
  • Added support for reducing gibberish ticket by adding a configurable threshold for all supported language.
  • iOS 9 feature: In-Device search - Now you can make your FAQs searchable with core spotlight.
  • iOS 9 feature: Bitcode distribution - Now the iOS bundle will have a bit code enabled version along in the SDK archive.
  • The Customer Satisfaction survey view is now a part of the messages scroll view. This makes it easier for users of landscape apps to view previous messages.
  • Changed the default value of showConversationResolutionQuestion flag to true.
  • Moved graphical assets location to Xcassets
  • FAQ Search algorithm improvement: Improved the FAQ search relevance threshold for fuzzy match to make it strict.
  • FAQ Search algorithm improvement: Sometimes search term was not highlighted if it was with a prepending or appending punctuation mark
  • FAQ Search algorithm improvement: FAQs were listed twice in search results
  • Added new HelpshifSupport API to replace older Helpshift API

4.15.0

September 25, 2015

Release notes:

  • Added a flag for toggling fallback languages in FAQs to english. In case you have FAQs in multiple languages but do not wish to fallback to English if localisation is missing, set ‘enableDefaultFallbackLanguage’ to ‘no’ in Helpshift’s install call.
  • Fix: Renamed a public method that could cause namespace issue with other libraries.
  • Fix: Fixed a bug that could prevent a database from being created.

4.14.1

September 15, 2015

Release notes:

  • Fix: Localisations on iOS 9.
  • Fix: Sometimes admin attachments do not download on re-installing app or migrating to a newer version.

If your FAQ images are not loading on iOS 9 click here to know what you need to do to fix this.

4.14.0

September 10, 2015

Release notes:

  • Filter FAQs by category tags.
  • Added configurability to the conversation resolution flow by adding flag showConversationResolutionQuestion. See note below for details.
  • Increased the accuracy of free disk space on the device.
  • Added support for 12 new languages: Danish, Slovak, Catalan, Greek, Finnish, Croatian, Malay, Norwegian, Romanian, Swedish, Ukrainian and Hebrew.
  • Changed the default conversation placeholder to "How can we help?"
  • Added error reporting capability for logging and reporting Helpshift crashes on runtime. This allows helpshift to get hold of all crashes and crash details that occurred in production due to Helpshift api or execution in Helpshift flows.
  • By default this is turned on.
  • [Bug fix] FAQ rendering issue.
    • Issue - FAQ was getting clipped before the first fold causing for FAQ text to appear clipped.
    • Cause - This was introduced when with the handling of a crash on older devices (iPhone 4s for UIVewbview).
    • Resolution - We have ensured that the UIWebView rendering happens on the main UI rendering thread.
    • Impact - This issue existed in v4.13 which has now been fixed.

Developers can now choose to skip the issue resolution questions (Y/N) by setting the key showConversationResolutionQuestion as No. This will lead the user to the CSAT screen after the issue is resolved by the agent. More details here. Available in Portrait & Landscape * Default value for showConversationResolutionQuestion is set to No. If you wish to show the Y/Ns question after the issue is resolved, please set the showConversationResolutionQuestion to Yes

* We have observed that the error reporting capability does not work if your app already has a crash logger that is not crashalytics.

4.13.0

August 19, 2015

Release notes:

  • Improved ticket avoidance to include the FAQs flows.
  • Added a feature that prevents empty or gibberish tickets from being filed.
  • Added support for two new languages: Polish and Arabic
  • Bug fixes
  • UI fixes

4.12.1

July 17, 2015

Release notes:

  • Add workaround for iOS UIScrollView inconsistency bug.
  • Bug fixes
  • UI fixes

4.12.0

July 10, 2015

Release notes:

  • Fix the bug in handling conversations with special characters in them.
  • Fix the FAQs syncing bug during migrations.
  • Move more code to ARC.
  • Improve the FAQ on device search with Fuzzy matching.
  • Fix iOS 6 compatibility.
  • UI fixes

4.11.1

June 2, 2015

Release notes:

  • Bug fixes

4.11.0

May 26, 2015

Release notes:

  • Ability to change SDK language dynamically.
  • Added fuzzy search for FAQ searches.
  • Search term highlighting for FAQs.
  • Additional navigation bar customizations.
  • Bug fixes.
  • UI fixes.

4.10.2

March 25, 2015

Release notes:

  • Bug fixes
  • UI fixes

4.10.1

March 20, 2015

Release notes:

  • New optional delegate method called when a Helpshift session begins: - (void) helpshiftSessionHasBegun;
  • This is a counterpart to the existing delegate that is called when a Helpshift session ends: - (void) helpshiftSessionHasEnded;
  • New optional delegate method that is called when user complete customer satisfaction survey after issue getting resolved. - (void) userCompletedCustomerSatisfactionSurvey:(NSInteger)rating withFeedback:(NSString *)feedback;
  • Added support for Hungarian, Czech, Slovenian and Traditional Chinese languages.
  • UI fixes
  • Bug fixes

4.10.0

March 4, 2015

Release notes:

  • Allow admins and agents to attach files with replies
  • Allow admins and agents to reopen conversations
  • Added multi-user feature for support conversations
  • Added new delegate methods for conversation updates
  • Bug fixes
  • UI fixes

4.9.1

October 9, 2014

Release notes:

  • Bug fixes

4.9.0

October 7, 2014

Release notes:

  • Added an API option "showSearchOnNewConversation" which when enabled will enhance ticket avoidance by suggesting relevant FAQs to the users before they start a new conversation.
  • Added an API option "enableFullPrivacy" which when enabled will restrict the user from attaching a screenshot and from sending personally identifiable information in meta-data.
  • UI fixes.
  • Bug fixes.

4.8.0

September 16, 2014

Release notes:

  • Full iOS 8 compatibility.
  • Bug fixes.
  • UI fixes.

4.7.0

September 2, 2014

Release notes:

  • Added support for Customer satisfaction survey, which prompts your app users to rate their customer support experience with your agents.
  • Agent names will now be visible in an ongoing conversation.
  • Added a API option, "conversationPrefillText", for prefilling new conversation description.
  • Added a API option, "hideNameAndEmail", for conditionally hiding name and email fields when starting a new conversation.
  • UX improvements for attaching screenshot.
  • Removed FAQ sync status.
  • Added support for deep-links in FAQs.
  • Bug fixes.
  • UI fixes.

4.6.0

July 9, 2014

Release notes:

  • Added a API option "requireEmail" to make emails compulsory or optional in the new conversation form.
  • Added fixes for iOS 8.
  • Added fixes for empty custom metadata.
  • Updated Korean translations.
  • Bug fixes
  • UI fixes

4.5.0

June 6, 2014

Release notes:

  • Optimized FAQ updates. Changes to FAQs in the admin are now updated and shown as soon as the SDK is opened.
  • Users can now directly attach screenshots while submitting new conversation or during an ongoing conversation.
  • New options for enableContactUs flag for ticket avoidance: ALWAYS, AFTER_VIEWING_FAQS and NEVER
  • setName:andEmail: API can now clear name and email if nil is passed for both.
  • Automatic app rating reminder is now available alongside the manual app rating API.
  • Bug fixes
  • UI fixes

4.4.0

April 30, 2014

Release notes:

  • Added new app rating API (showAlertToRateAppWithURL:withCompletionBlock:). Automatic review request is now removed in this release.
  • Conversation text and message reply text are now buffered, if users leave the screen while typing is in progress.
  • Improved message resolution interaction.
  • Added a new option in skinning plist for cell selection color.
  • Improved on some skinning bugs.
  • Improved on new conversation submission warnings.
  • Improved on FAQ helpful/unhelpful UI interaction.
  • Various bug fixes (crashes related to migration).
  • UI fixes

4.3.1

March 12, 2014

Release notes:

  • Critical migration bug fix that caused a conversation related crash

4.3.0

March 7, 2014

Release notes:

  • Added method pauseDisplayOfInAppNotification: to pause/resume display of in-app notifications
  • Added optional delegate method didReceiveInAppNotificationWithMessageCount: for in-app notifications
  • Added Dutch translations
  • Potrait only/Landscape only rotation now supported in the SDK, if app supports the same
  • New inapp notification delegate method
  • Review request in conversation can now be customized via localized strings.
  • Bug fixes
  • UI fixes

4.2.1

February 23, 2014

Release notes:

  • Fixed some critical crashes (Crash during screenshot attach, FAQ mark helpful/unhelpful and others).

4.2.0

February 03, 2014

Release notes:

  • Added support for fullscreen and formsheet modal presentation styles on iPad
  • Added Turkish translations
  • library now contains a 64-bit simulator slice
  • support for custom metadata in API options
  • Bug fixes
  • UI fixes

4.1.0

December 23, 2013

Release notes:

  • Conversation forwarding feature added to SDK
  • New Rate/Review & Feedback feature
  • Now using CFBundleShortVersionString instead of CFBundleVersion for app version
  • Added support for background image in HelpshiftConfig.plist
  • Fixed bugs related to getNotificationCountRemote being called from inside helpshiftSessionHasEnded
  • Improved UX for resolution rejected by user for resolved conversations
  • Bug fixes
  • UI fixes
  • Changes to HelpshiftLocalizable.strings

4.0.0

December 4, 2013

Release notes:

  • Multiple issues and inbox is no longer supported
  • The conversation interface has been unified into a single channel
  • New API calls for support tools and install method.
  • When FAQ is marked unhelpful, users can contact you to tell you why
  • Moved helpshift db from Documents/ folder to Library/ folder
  • New strings for localizations
  • Bug fixes
  • UI fixes

Older release notes

Release notes pre v4.0.0 can be found in SDK 3.x docs.