Helpshift APIs

Helpshift provides a way to use each functional element of the SDK separately based on your requirements. You can call only specific screens from the SDK based on the functionality you want to expose in your app.

Note

All the public APIs in the SDK should be called after initializing the SDK via Helpshift installWithPlatformId API

Integrating Contact Us & In App Messaging

You can use the API call showConversationWithConfig: to allow a user to directly send feedback or start a new conversation without having to first view FAQs. Once user starts a new conversation, this API call will show the conversation screen. The conversation will continue until it is resolved or rejected by the agent.

Objective-C Example

Definition	showConversationWithConfig:
Example Code	[Helpshift showConversationWithConfig:configDictionary]; where configDictionary is a NSDictionary that represents the configuration that needs to be set to the conversation.
Use with	"Contact Us" or "Send Feedback" button

Swift Example

Definition	showConverstion(withConfig:)
Example Code	Helpshift.showConversation(withConfig:configDictionary) where configDictionary is a Dictionary that represents the configuration that needs to be set to the conversation.
Use with	"Contact Us" or "Send Feedback" button

Supports these API Options.

Integrating FAQs

You can use the API call showFAQsWithConfig: to provide a way for the user to invoke the purpose-built help/support section in your app. This is the easiest approach to enable help in your app as it bundles all the capabilities of the Helpshift SDK in a simple and intuitive interface. You can wire this API call to a "Help" or "Support" action in your app.

This View Controller combines the FAQ, Search and Contact Us functionality together in a single interface. In this view, a user can search for a specific question in the FAQ failing which they can report an issue. When you respond back to their question from the Helpshift Agent Dashboard, the reply will be shown as a count besides Contact Us, clicking on which will open up the conversation.

Objective-c Example

Definition	showFAQsWithConfig:
Example Code	[Helpshift showFAQsWithConfig:configDictionary]; where configDictionary is a NSDictionary that represents the configuration that needs to be set to the FAQ screen.
Use with	"Help" or "Support" button

Swift Example

Definition	showFAQs(withConfig:)
Example Code	Helpshift.showFAQs(withConfig: configDictionary) where configDictionary is a Dictionary that represents the configuration that needs to be set to the FAQ screen.
Use with	"Help Us" or "Support" button

Supports these API Options.

Showing a Particular FAQ Section

You can use the API call showFAQSection:withConfig: to show FAQs from a particular FAQ section.

You will need the publish-id of the FAQ section to use this API:

This feature works like a permalink for displaying specific FAQ sections as context sensitive help in your app. For example, if your app requires the user to login to using email, facebook and twitter, you could wire a help action on the login screen that can link to the Helpshift FAQ section called "Login help" which has several questions related to login methods.

Objective-c Example

Definition	showFAQSection:withConfig:
Example Code	[Helpshift showFAQSection:sectionId withConfig:configDictionary]; where sectionId is the section publishId and configDictionary is a NSDictionary that represents the configuration that needs to be set to the FAQ screen

Swift Example

Definition	showFAQSection(_:withConfig:)
Example Code	Helpshift.showFAQSection(sectionId, withConfig: configDictionary) where sectionId is the section publishId and configDictionary is a NSDictionary that represents the configuration that needs to be set to the FAQ screen

Supports these API Options.

Showing a Particular FAQ

You can use the API showSingleFAQ:withConfig: to show a single FAQ.

You'll need the publish-id of the FAQ to use this API:

Objective-C Example

Definition	showSingleFAQ:withConfig:
Example Code	[Helpshift showSingleFAQ:faqId with:self config:configDictionary]; where faqId is the publishId of that particular FAQ and configDictionary is a NSDictionary that represents the configuration that needs to be set to the FAQ screen

Swift Example

Definition	showSingleFAQ(_:withConfig:)
Example Code	Helpshift.showSingleFAQ(faqId, withConfig: configDictionary) where faqId is the publishId of that particular FAQ and configDictionary is a Dictionary that represents the configuration that needs to be set to the FAQ screen

Supports these API Options.

Closing an open SDK session

You can use the API closeSession to close an active SDK session. Calling this API will close any open SDK screens and invoke the corresponding lifecycle delegate methods. If no SDK session is active, calling this API will have no effect.

Objective-C Example

[Helpshift closeSession];

Swift Example

Helpshift.closeSession()

Getting the SDK version

You can use the API sdkVersion to get the current version of Helpshift SDK.

Objective-C Example

NSString *sdkVersion = [Helpshift sdkVersion];

Swift Example

let sdkVersion = Helpshift.sdkVersion()

Set SDK language

For more info about this API and languages you can refer here.

User Hub APIs

Our new Identity system - User Hub, introduces various APIs for managing users and their data. Refer to the linked section for details.