Skip to main content

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

showConversation​

You can use the API call showConversationWith:config: to allow a user to directly send feedback or start a new conversation without having to first view FAQs. Once, a 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.

DefinitionshowConversationWith:config:
Example Code [Helpshift showConversationWith:self config:configDictionary]; // where self is the view controller you're calling Helpshift from and configDictionary is a NSDictionary 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 showFAQsWith:config: 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.

DefinitionshowFAQsWith:config:
Example Code [Helpshift showFAQsWith:self config:configDictionary]; // where self is the view controller you're calling Helpshift from and configDictionary is a NSDictionary that represents the configuration that needs to be set to the FAQ screen.
Use with"Help" or "Support" button

Showing a Particular FAQ Section​

You can use the API call showFAQSection:with:config: to invoke a particular section of your FAQs with its FAQ section publish-id

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.

DefinitionshowFAQSection:with:config:
Example Code [Helpshift showFAQSection:sectionId with:self config:configDictionary]; // where sectionId is the section publishId, self is the view controller you're calling Helpshift from and configDictionary is a NSDictionary that represents the configuration that needs to be set to the FAQ screen

Showing a Particular FAQ​

You can use the API showSingleFAQ:with:config: to show a single FAQ. You will need to pass the publish-id of the FAQ to be shown to this API.

DefinitionshowSingleFAQ:with:config:
Example Code [Helpshift showSingleFAQ:faqId with:self config:configDictionary]; // where faqId is the publishId of that particular FAQ, self is the view controller you're calling Helpshift from and configDictionary is a NSDictionary that represents the configuration that needs to be set to the FAQ screen

Publish ID of FAQ which is shown when you expand a single FAQ on admin side (yourcompanyname.helpshift.com/admin/faq/)

setLanguage​

You can set the SDK language using the setLanguage: method. By default, the device's prefered language is used by the SDK. The call will fail in the following cases :

  • If a Helpshift session is already active at the time of invocation
  • Language code is incorrect

For more info about languages you can refer here

DefinitionsetLanguage:
Example Code [Helpshift setLanguage:"fr"]; // where @"fr" is the language code. You can also pass a language code and a country code like: [Helpshift setLanguage:@"zh-SG"];