Tracking Android

Track events and user actions when the user starts a new conversation. Attach custom metadata to every conversation started via the SDK.

Adding Tags to Conversations

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.

Pass this Map to ShowConversation() API.

show me

On tag names & compatibility

  • Tags must be pre-created in the Helpshift Dashboard (Settings → Tags), otherwise they will be ignored.
  • The attached tags must exactly match the tags present on the dashboard.

Set Custom Issue Fields

If you want to set Custom Issue Fields at the time of Issue creation, follow the steps.

  1. Initialise a top level custom issue fields' Map
  2. Define your custom issue field Map
  3. Add the "type" and "value" for that custom issue field You can find the type in this constants class HelpshiftCustomIssueFieldParameter

Pass this Map to ShowConversation() API.

show me

The following are the valid values for the type key of a Custom Issue Field.

  • NewSingleLineParameter
  • NewMultiLineParameter
  • NewNumberParameter
  • NewCheckboxParameter
  • NewDropdownParameter
  • NewDateParameter

Compatibility table for type and values:

Type Value Comments
NewSingleLineParameter string Character limit of 255
NewMultiLineParameter string Character limit of 100,000
NewNumberParameter int
NewDropdownParameter string Drop-down options should exist for the given Custom Issue Field
NewDateParameter DateTime Epoch time. For example -
NewCheckboxParameter boolean

On Custom Issue Fields keys & compatibility

  • Custom Issue Fields must be created in the Helpshift Dashboard (Settings → Custom Issue Fields), otherwise they will be ignored. Read more here