This is a beta SDK

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.

There are 4 ways to call Helpshift in your app:

  1. ShowConversation
  2. ShowFAQs
  3. ShowFAQSection
  4. ShowSingleFAQ

showConversation

You can use the api call ShowConversation(string conversationPrefillText = "") to allow a user to directly 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.

Definition
ShowConversation(string conversationPrefillText = "")
Example Code
Helpshift.ShowConversation(); // where self is the view controller you're calling Helpshift from
Use with
"Contact Us" or "Send Feedback" button

Supports these API Options

ShowFAQs

You can use the api call ShowFAQs() to show FAQs 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. Users can browse FAQs, search for an FAQ, and file issues with Support.

Definition
ShowFAQs()
Example Code
Helpshift.ShowFAQs(); // where self is the view controller you're calling Helpshift from
Use with
"Help" or "Support" button

Supports these API Options

English translation will be used for non-localized FAQs

ShowFAQSection

You can use the api call [ShowFaqSection(int faqSectionPublishId):]to show faqs from a particular FAQ section. 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 log in 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.

You will need the Section Publish ID from the FAQ tab of Helpshift Dashboard:

Definition
ShowFaqSection(int faqSectionPublishId)
Example Code
Helpshift.ShowFaqSection(1) // where self is the view controller you're calling Helpshift from and "1" is the FAQ section publish-id
Use with
"Login Help" or other category-specific sections

Supports these API Options

English translation will be used for non-localized FAQs

ShowSingleFAQ

You can use the api call [ShowSingleFAQ(int faqPublishId)] to show a single faq question.

Definition
ShowSingleFAQ(int faqPublishId)
Example Code
Helpshift.ShowSingleFAQ(1);
Use with
a '?' button when your user is performing a specific action

Supports these API Options

English translation will be used for non-localized FAQs