Sample Projects

Trying out a sample project is the easiest way to get started.

Examples for integrating and using the SDK can be found on Github.

HelpshiftDemo
show different support screens in your app.
FCMClient
implement FCM Push in your app along with helpshift support.
GcmClient
implement GCM Push (using Google Play Services) in your app along with helpshift support. This is a port of GcmClient project from Gradle to Ant build system.
GCMApp (Deprecated)
implement GCM Push in your app along with helpshift support.
HSThemeApp
show theming capabilities of the helpshift android sdk.
HelpshiftDemoMaven
HelpshiftDemo project using maven instead of Ant
HelpshiftDemoGradle
HelpshiftDemo project using Gradle instead of Ant

Trying out HelpshiftDemo

  1. In HelpshiftDemoActivity.java initialize Helpshift with your unique API_KEY, DOMAIN and APP_ID. To get them:

    1. Navigate to Settings>SDK (for Developers) in your agent dashboard and scroll down to "Initializing Helpshift" section.

    2. Select your App from the dropdown and copy the three tokens to be passed when initializing Helpshift.

    Update hs.install call in your activity's onCreate method with these tokens.

  2. Run the following inside the /HelpshiftDemo directory to start:

    $ android update project -t android-17 -p .
    

Test your integration

  1. Tap Contact Us button in the sample app, you should see the New Conversation screen.

    HelpshiftDemo

  2. File an issue, and watch it appear in your agent dashboard. Once you've resolved that issue, you should go ahead and Integrate Helpshift in your app.

It's time to talk to your users now!