Track events and user actions when the user starts a new conversation. Attach custom metadata to every conversation started via the SDK.
All the public APIs in the SDK should be called after initializing the SDK via HelpshiftSdk.install() API
You can attach tags while reporting an issue by passing them to the configMap
object at the time of calling ShowConversation
. You can pass an array of strings with a key "tags"
which will get added as Tags when the issue is created.
For example:
using Helpshift; private HelpshiftSdk help; void Awake(){ // install call here } // configuration map void openHelpshift(){ Dictionary<string, object> configMap = new Dictionary<string, object>(); // other configurations // .. configMap.Add("tags", new String[] { "tag1", "tag2" }) // open the support chat screen help.ShowConversation(configMap); }
On tag names & compatibility
If you want to add Custom Metadata at the time of Issue creation, follow the steps.
Dictionary
Dictionary
Dictionary
configMap
with key "customMetadata"
to any of the SDK X APIs (like ShowConversation(configMap)
).Use code:
using Helpshift; private HelpshiftSdk help; void Awake(){ // install call here } void openHelpshift(){ Dictionary<string, string> customMetadataDictionary = new Dictionary<string, string>(); customMetadataDictionary.Add("Level", "9"); customMetadataDictionary.Add("Spend", "46.55 USD"); customMetadataDictionary.Add("Device Timestamp", DateTime.UtcNow.ToLongTimeString()); Dictionary<string, object> config = new Dictionary<string, object>(); // other configs... //.. config.Add("customMetadata", customMetadataDictionary); help.ShowConversation(configMap); }
Metadata should only be sent as String key-value pairs.
If you want to set Custom Issue Fields at the time of Issue creation, follow the steps.
Dictionary
Dictionary
"type"
and "value"
for that custom issue fieldconfigMap
with key "customIssueFields"
of the ShowConversation(configMap)
using Helpshift; private HelpshiftSdk help; void Awake(){ // install call here } void openHelpshift(){ Dictionary<string, object> joiningDate = new Dictionary<string, object>(); joiningDate.Add("type", "date"); joiningDate.Add("value", DateTimeOffset.UtcNow.ToUnixTimeMilliseconds()); Dictionary<string, string> stockLevel = new Dictionary<string, string>(); stockLevel.Add("type", "number"); stockLevel.Add("value", "1505"); Dictionary<string, string> employeeName = new Dictionary<string, string>(); employeeName.Add("type", "singleline"); employeeName.Add("value", "Bugs helpshift"); Dictionary<string, string> isPro = new Dictionary<string, string>(); isPro.Add("type", "boolean"); isPro.Add("value", "true"); Dictionary<string, object> cifDictionary = new Dictionary<string, object>(); cifDictionary.Add("joining_date", joiningDate); cifDictionary.Add("stock_level", stockLevel); cifDictionary.Add("employee_name", employeeName); cifDictionary.Add("is_pro", isPro); Dictionary<string, object> config = new Dictionary<string, object>(); // other configs... //.. config.Add("customIssueFields", cifDictionary); help.ShowConversation(configMap); }
The following are the valid values for the type
key of a Custom Issue Field.
Compatibility table for type and values:
Type | Value | Comments |
---|---|---|
singleline | string | Character limit of 255 |
multiline | string | Character limit of 100,000 |
number | string | |
dropdown | string | Drop-down options should exist for the given Custom Issue Field |
date | number | Epoch time. For example - Date.now() |
checkbox | boolean |
On Custom Issue Fields keys & compatibility
Breadcrumbs can be used to track events or end-user actions. It helps you to add debugging information regarding end-user actions, which will be passed along with every new conversation on Helpshift’s Agent Dashboard. To leave breadcrumbs, use LeaveBreadcrumb
API —
For example:
help.LeaveBreadcrumb("<any-breadcrumb-string>");
Breadcrumbs are collected within the set breadcrumb limit. The limit is set under the SDK Configurations section for App Settings in the Helpshift’s Agent Dashboard. Breadcrumbs are collected in a FIFO queue. If you want to clear the breadcrumbs, use the ClearBreadcrumbs
API —
For example:
help.ClearBreadcrumbs();
If you want to add debug logs at specific places within your application which will help you debug issues filed by the user, you can instantiate and use the HelpshiftLog class and its methods which will provide varying degress of logging. For example, if you want to attach debug level logs please add the following code
For example:
HelpshiftLog.d("<debug-tag>", "<debug-message>");
Debug logs are collected within the set debug logs limit. The limit is set under the SDK Configurations section for App Settings in the Helpshift’s Agent Dashboard. Debug logs are collected in a FIFO queue.