Helpshift APIs

Helpshift provides a way to use each functional element of the SDK separately based on your requirements.

Integrating Contact Us & In App Messaging

newConversation.png

You can use this API call 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. To configure SDK, you can pass various config options as a parameter as mentioned below. Checkout more config options here

Integrating FAQs

showFAQs.png

You can use this API 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.

To configure the FAQs screen, you can pass various config options as parameter as mentioned below. Checkout more config options here

Showing a Particular FAQ Section

showFAQSection.png

You can use this API 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.

You'll need the publish-id of the section in this case:

Showing a Particular FAQ

showSingleFAQ.png

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

You'll need the publish-id of the FAQ in this case:

Set SDK language

You can set the SDK language for the given locale using the below API. For more info about languages you can refer here