Skip to main content

Getting Started

You're 3 steps away from adding great in-app support to your Unreal Engine game.

Guide to integrating the Unreal Engine plugin for the Helpshift SDK X.

Requirements​

  • Unreal 4.26 and above.
  • Supported Android OS versions:
    • SDK X is functional only above API Level 24 i.e Android OS 7 Nougat and above.
    • The minSDKVersion in code is kept as API Level 16 to allow importing the SDK and compiling in apps that allow installation till API Level 16 i.e Android 4.4 Jelly Bean.
    • If your app is installed on a device below API level 24 (i.e below Android OS 7 Nougat) then you can choose to have a different medium for providing support. For example, Email, Web etc. We log an UnsupportedOSVersionException if the SDK is initialized below API Level 24.
  • Supported iOS versions: iOS 13 and above
  • For details regarding Helpshift SDK's support policy, please refer to this article.
Note

With 10.3.0 release, applications utilizing UE 4.26 must be built using Xcode 14.1 or later.

Download Helpshift Unreal SDK​

SDK X - In-app Customer Service​

Helpshift SDK .zip folder includes:

HelpshiftSDKUnreal Engine plugin package of Helpshift SDK X

Add Helpshift to your Unreal project​

  • Unzip the Helpshift Unreal SDK package.
  • Copy the plugin (HelpshiftSDK) directory into [YOUR_PROJECT]/Plugins directory
  • After that, once you reopen your project, the plugin should appear in the Plugins section

Initializing Helpshift in your app​

  1. First, create an app on the Helpshift Dashboard

  2. Create an app with Android and iOS as selected Platform

Helpshift uniquely identifies each registered App with a combination of 2 tokens:

Domain NameYour Helpshift domain. E.g. happyapps.helpshift.com
Platform IDYour App's unique platform id (App's App Id on dashboard is your platform Id)
You can find these by navigating to `Settings`>`SDK (for Developers)` in your agent dashboard. Select your App and _check Android as a platform_ from the dropdowns and copy the 2 tokens to be passed when initializing Helpshift.

You should now go to the Project Settings -> Helpshift SDK and configure your specific project fields. Copy the domain and platformId from the dashboard. __

The Drawable Path and Sound Path settings are used if you want to customize the notification icons and/or sound on Android. The contents of those folders will be copied for use as android resource files.

Call the Init function before any other interaction with the Helpshift SDK (preferably in the EventConstruct call)

__

The Init call takes a map of the additional parameters. All of the parameters are optional, which means you can pass an empty map. The meaning of different keys and their possible values for Android can be found here

Important

Android OS version Support

Calling Init below android SDK version 24 will not work. All the APIs will be non operable.

Start using Helpshift​

Helpshift is now integrated in your app. You should now use the support APIs for conversation screens inside your app.

Note

Since the Helpshift plugin is meant for mobile devices only, you should put all Helpshift calls inside conditional checks to make sure they are only called when running on a device.