Getting Started

Requirements

• Xcode 12.0 and above.
• Cocoapods v1.10.0
• Supported iOS versions:
  • iOS 16, 15, 14, 13, 12, 11, 10

Automated Integration using Cocoapods

To start using SDK X v10.2.1 in your project, add the following line to your Podfile

pod 'HelpshiftX', '10.2.1'

And run pod install or pod update to refresh your cocoapods dependencies.

You can now move on to Initializing Helpshift in your App.

Automated Integration using Swift Package Manager

To start using Helpshift v10.2.1 in your SPM project, add the following package URL to your project's "Package Dependencies" section

https://github.com/helpshift/HelpshiftX

For version rules, we recommend using either "Exact" or "Up to Next Minor" and manually updating the version number when a major version of Helpshift SDK X is released.

You can now move on to Initializing Helpshift in your App.

Manual Integration

Get the latest SDK zip

Download the latest for the Helpshift iOS SDK.

Download SDK 10.2.1

The zip file contains

Add the latest stable SDK release to your project

• Unzip the SDK and drag drop HelpshiftX.xcframework into your Xcode project
• In the General section of your app target, verify that the HelpshiftX.xcframework is present in the Framework, Libraries, and Embedded Content section with the option Embed and Sign selected from the Embed options dropdown.    show me
• After successful integration, Build Phases should look like this:    show me

Start using Helpshift

Helpshift is now integrated in your app and ready to collect meaningful data about your users.

Initializing Helpshift in your app

1. First, create an app on the Helpshift Dashboard show me

2. Create an app with iOS as a selected Platform show me

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

You can find these by navigating to Settings>SDK (for Developers) in your agent dashboard. Select your App and check iOS as a platform from the dropdowns and copy the 2 tokens to be passed when initializing Helpshift. show me

@import HelpshiftX;
...
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    ...
    NSDictionary *config = @{} // Your config                 
    [Helpshift installWithPlatformId:@"YOUR_PLATFORM_ID"
                              domain:@"YOUR_DOMAIN"
                              config:config];
    ...
    return YES;
}

import HelpshiftX
...
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        ...
        let config = [String:String]() // Your config
        Helpshift.install(withPlatformId: "YOUR_PLATFORM_ID", domain: "YOUR_DOMAIN", config: config)
        ...
        return true
    }
...

Next up