Working with the ASAP SDK's Event Callbacks for Mobile Platforms
Why integrate Events Callback?
- Navigating to Articles: Track which articles users visit and the frequency of visits. This information helps you identify popular content and areas where users may need more information.
- Providing Article Feedback: Users can share their opinions on specific articles. Capturing this feedback allows you to assess the effectiveness of your content and make necessary adjustments to meet user needs better.
- Posting Comments on Community Topics: Monitoring comments in community discussions can help gauge user engagement levels and identify common questions or concerns. This helps build a more responsive and interactive community.
- Additional Activities: The feature can be extended to track other relevant user actions, giving you a holistic view of user behaviour.
Code snippet for Android:
To receive the Help Center user event updates on your Android application, please add the code snippet below to your project code (preferably the onCreate method of the application class). Make sure to execute the script below before triggering the SDK screens.
- ZDPortalConfiguration.setEventsCallback(object : ZDPEventsCallback {
- override fun onEvent(eventName: String, data: HashMap<String, String>) {
- val eventsScreen = data.getOrDefault(ZDPEvents.EventScreen, null)
- val eventsSource = data.getOrDefault(ZDPEvents.EventSource, null)
- val eventsData = data.getOrDefault(ZDPEvents.EventData, null)
- // Handle the event data here
- println("Event Name: $eventName")
- println("Event Screen: $eventsScreen")
- println("Event Source: $eventsSource")
- println("Event Data: $eventsData")
- }
- })
Parameters
- eventName (type-String): The unique name of the event such (e.g., ZDP_KB_ARTICLE_LIKE, ZDP_KB_ARTICLE_SHARE, ZDP_COMMUNITY_REPLY_ADD)
- data (type-HashMap<String, String>): Additional event information.
- eventsScreen: The screen where the event occurred (e.g., Home, Articles_List)
- eventsSource: The UI element related to the event (e.g., Recent_Articles)
- eventsData: Extra data about the event, like the permalink of a clicked article or a selected filter.
Code snippet for iOS:
To handle events, you must create a class that conforms to the ZDPAnalyticsDelegate protocol. This class will implement the handleZDPEvents function to capture and log event details, such as the event name and the associated data.
- class AnalyticHandler: ZDPAnalyticsDelegate {
- static let shared = AnalyticHandler()
- // Function that handles events
- func handleZDPEvents(eventName: ZDPortalUIAction, withData eventData: [String : Any]?) {
- // Print the event name and event data for logging or debugging
- print("Event name is: \(eventName.rawValue)")
- print("Event Data is: \(String(describing: eventData))")
- }
- }
Before the SDK is initialized, the delegate instance (AnalyticHandler class) must be assigned to the ZDPAnalytics.sharedInit.delegate property. This step ensures that the event-handling logic will be called every time an event occurs.
- // Assign the delegate before initializing the SDK
- ZDPAnalytics.shared.delegate = AnalyticHandler.shared
Parameters
- ZDPortalUIAction: Enum containing predefined unique event names such (ZDP_KB_ARTICLE_LIKE, ZDP_KB_ARTICLE_SHARE, ZDP_COMMUNITY_REPLY_ADD)
- eventData: A dictionary that contains additional details related to the event like Event Screen, Event Source & Event Data.
- Event Screen: The screen where the event occurred (e.g., Home, Articles_List)
- Event Source: The UI element related to the event (e.g., Recent_Articles)
- Event Data: Extra data about the event, like the permalink of a clicked article or a selected filter.
Core Events supported in Android & iOS
Knowledge Base
Module | Event Description | Event Stats |
Knowledge Base | The event captures the article's clicks from the global search. | Event Name: ZDP_SEARCH_ARTICLE_CLICK Event screen: Global_Search Event Data: permalink |
Knowledge Base | This event captures the KB category clicks in the category screen. | Event Name: ZDP_KB_CATEGORY_CLICK Event screen: Categories_List Event Data: category_permalink |
Knowledge Base | This event captures the KB sub-category clicks in the KB sub-category screen. | Event Name: ZDP_KB_SECTION_CLICK Event screen: Sections_List Event Data: section_permalink |
Knowledge Base | This event captures the popular article clicks in the KB sub-category screen. | Event Name: ZDP_KB_ARTICLE_CLICK Event screen: Sections_List Event Source: Popular_Articles Event Data: article_permalink |
Knowledge Base | This event captures the recent articles clicked on the KB sub-category screen. | Event Name: ZDP_KB_ARTICLE_CLICK Event screen: Sections_List Event Source: Recent_Articles Event Data: article_permalink |
Knowledge Base | This event captures the article clicks in the article list screen. | Event Name: ZDP_KB_ARTICLE_CLICK Event screen: Articles_List Event Data: article_permalink |
Knowledge Base | This event captures the article's likes in the article detail screen. | Event Name: ZDP_KB_ARTICLE_LIKE Event screen: Article_Detail Event Data: article_permalink |
Knowledge Base | This event captures the article's dislikes in the article detail screen. | Event Name: ZDP_KB_ARTICLE_DISLIKE Event screen: Article_Detail Event Data: article_permalink |
Knowledge Base | This event captures the number of clicks for the article comments on the detail screen. | Event Name: ZDP_KB_COMMENTS_CLICK Event screen: Article_Detail Event Data: article_permalink |
Knowledge Base | This event captures the article share clicks in the article detail screen. | Event Name: ZDP_KB_ARTICLE_SHARE Event screen: Article_Detail Event Data: article_permalink |
Knowledge Base | This event captures the previous and subsequent article clicks on the detail screen. | Event Name: ZDP_KB_ARTICLE_CLICK Event screen: Article_Detail Event Source: Previous_Next_Articles Event Data: article_permalink |
Knowledge Base | This event captures the related article clicks in the article detail screen. | Event Name: ZDP_KB_ARTICLE_CLICK Event screen: Article_Detail Event Source: Related_Articles Event Data: article_permalink |
Knowledge Base | This event captures the number of times the article's attachment was opened on the detail screen. | Event Name: ZDP_ATTACHMENT_PREVIEW Event screen: Article_Detail Event Data: article_permalink |
Knowledge Base | This event captures the number of times the article's attachment was downloaded from the detail screen. | Event Name: ZDP_ATTACHMENT_DOWNLOAD Event screen: Article_Detail Event Data: article_permalink |
Knowledge Base | This event captures the article's tags clicks in the article detail screen. | Event Name: ZDP_KB_ARTICLE_TAG_CLICK Event screen: Article_Detail Event Data: tag_name |
Knowledge Base | This event captures the article's tag clicks on the tags article detail screen. | Event Name: ZDP_KB_ARTICLE_CLICK Event screen: Tags_Articles_List Event Data: article_permalink |
Knowledge Base | This event captures the feedback submitted in the article's feedback screen. | Event Name: ZDP_KB_FEEDBACK_SUBMIT Event screen: Article_Feedback Event Data: article_permalink |
Knowledge Base | This event triggers the feedback submitted in the article's feedback is skipped. | Event Name: ZDP_KB_FEEDBACK_SKIP Event screen: Article_Feedback Event Data: article_permalink |
Knowledge Base | This event indicates no data errors in the article detail screen. | Event Name: ZDP_KB_ARTICLE_NOT_AVAILABLE Event screen: Article_Detail Event Data: permalink |
Knowledge Base | This event indicates no data errors in the KB category screen. | Event Name: ZDP_KB_CATEGORY_NOT_AVAILABLE Event screen: Sections_List Event Data: permalink |
Knowledge Base | This event captures the article's listen button clicks in the article detail screen. | Event Name: ZDP_KB_ARTICLE_LISTEN_CLICK Event screen: Article_Detail Event Data: permalink |
Community
Events | Event Description | Event Stats |
Community | The event captures the topic's clicks from the global search. | Event Name: ZDP_SEARCH_TOPIC_CLICK Event screen: Global_Search Event Data: permalink |
Community | The event captures the topic's filter selection from the topic global search screen. | Event Name: ZDP_SEARCH_FILTER_SELECTION Event screen: Global_Search Event Source: Topics_Type_Filter Event Data: all_topics/discussion |
Community | The event captures the topic's sorting selection from the topic global search screen. | Event Name: ZDP_SEARCH_FILTER_SELECTION Event screen: Global_Search Event Source: Topics_Sort_By Event Data: relevance/publish_date |
Community | The event captures the community category clicks from the category list screen. | Event Name: ZDP_COMMUNITY_CATEGORY_CLICK Event screen: Categories_List Event Data: category_permalink |
Community | The event captures the community's recent topic clicks from the category screen. | Event Name: ZDP_COMMUNITY_TOPIC_CLICK Event screen: Recent_Topic_List Event Data: topic_permalink |
Community | The event captures the community's forum clicks from the sub-category screen. | Event Name: ZDP_COMMUNITY_FORUM_CLICK Event screen: Forums_List Event Data: forum_permalink |
Community | The event captures the community's most discussed topic clicks from the sub-category screen. | Event Name: ZDP_COMMUNITY_TOPIC_CLICK Event screen: Forums_List Event Source: Most_Discussed_Topics Event Data: topic_permalink |
Community | The event captures the community's sticky post topic clicks from the sub-category screen. | Event Name: ZDP_COMMUNITY_TOPIC_CLICK Event screen: Forums_List Event Source: Sticky_Posts Event Data: topic_permalink |
Community | The event captures the community's announcement topic clicks from the category screen. | Event Name: ZDP_COMMUNITY_TOPIC_CLICK Event screen: Forums_List Event Source: Announcement_Topics Event Data: topic_permalink |
Community | The event captures the community's categories follow clicks. | Event Name: ZDP_COMMUNITY_CATEGORY_FOLLOW Event screen: Forums_List / Topics_List Event Data: category_permalink |
Community | The event captures the community's categories unfollow clicks. | Event Name: ZDP_COMMUNITY_CATEGORY_UNFOLLOW Event screen: Forums_List / Topics_List Event Data: category_permalink |
Community | The event captures the community's follower's list screen openings. | Event Name: ZDP_COMMUNITY_FOLLOWERS_CLICK Event screen: Forums_List/Topics_List Event Data: category_permalink |
Community | The event captures the community's topic clicks. | Event Name: ZDP_COMMUNITY_TOPIC_CLICK Event screen: Topics_List Event Data: topic_permalink |
Community | The event captures the community's selected filters. | Event Name: ZDP_COMMUNITY_FILTER_SELECTION Event screen: Topics_List Event Data: all_topics/discussion_subLabel |
Community | The event captures the community topic's follow clicks. | Event Name: ZDP_COMMUNITY_TOPIC_FOLLOW Event screen: Topic_Detail Event Data: topic_permalink |
Community | The event captures the community topic's unfollow clicks. | Event Name: ZDP_COMMUNITY_TOPIC_UNFOLLOW Event screen: Topic_Detail Event Data: topic_permalink |
Community | The event captures the community topic's likes. | Event Name: ZDP_COMMUNITY_TOPIC_LIKE Event screen: Topic_Detail Event Data: topic_permalink |
Community | The event captures the community topic's share count. | Event Name: ZDP_COMMUNITY_TOPIC_SHARE Event screen: Topics_Detail Event Data: topic_permalink |
Community | The event captures the community topic's comment screen navigations. | Event Name: ZDP_COMMUNITY_COMMENTS_CLICK Event screen: Topic_Detail Event Data: topic_permalink |
Community | The event captures the community-related article clicks. | Event Name: ZDP_COMMUNITY_ARTICLE_CLICK Event screen: Topic_Detail Event Source: Related_Articles Event Data: permalink |
Community | The event captures the community topic's sticky post clicks. | Event Name: ZDP_COMMUNITY_TOPIC_CLICK Event screen: Topic_Detail Event Source: Sticky_Posts Event Data: topic_permalink |
Community | The event captures the community's participants' view clicks. | Event Name: ZDP_COMMUNITY_PARTICIPANTS_CLICK Event screen: Topic_Detail Event Data: topic_permalink |
Community | The event captures the community topic's listen button clicks. | Event Name: ZDP_COMMUNITY_TOPIC_LISTEN_CLICK Event screen: Topic_Detail Event Data: topic_permalink |
Community | The event captures the community topic's tag clicks in the topic detail screen. | Event Name: ZDP_COMMUNITY_TOPIC_TAG_CLICK Event screen: Topic_Detail Event Data: tag_name |
Community | The event captures the community topic's tag clicks in the tag topics list screen. | Event Name: ZDP_COMMUNITY_TOPIC_CLICK Event screen: Tags_Topics_List Event Data: topic_permalink |
Community | The event captures the community topic's clicks in the sticky topic list screen. | Event Name: ZDP_COMMUNITY_TOPIC_CLICK Event screen: Sticky_Topics_List Event Data: topic_permalink |
Community | The event captures the community topic's clicks on the announcement topic list. | Event Name: ZDP_COMMUNITY_TOPIC_CLICK Event screen: Announcement_Topics_List Event Data: topic_permalink |
Community | The event captures the community topics that were edited. | Event Name: ZDP_COMMUNITY_TOPIC_EDIT Event screen: Topic_Editor Event Data: topic_permalink |
Community | The event captures the community topics that were deleted. | Event Name: ZDP_COMMUNITY_TOPIC_DELETE Event screen: Topic_Detail Event Data: topic_permalink |
Community | The event captures the replies added to the community topics. | Event Name: ZDP_COMMUNITY_REPLY_ADD Event screen: Topic_Comments Event Data: topic_permalink |
Community | The event captures the edited replies on the community topics. | Event Name: ZDP_COMMUNITY_REPLY_EDIT Event screen: Topic_Comments Event Data: topic_permalink |
Community | The event captures the deleted replies on the community topics. | Event Name: ZDP_COMMUNITY_REPLY_DELETE Event screen: Topic_Comments Event Data: topic_permalink |
Community | The event captures the comments added to the community topics. | Event Name: ZDP_COMMUNITY_COMMENT_ADD Event screen: Topic_Comments Event Data: topic_permalink |
Community | The event captures the deleted comments on the community topics. | Event Name: ZDP_COMMUNITY_COMMENT_DELETE Event screen: Topic_Comments Event Data: topic_permalink |
Community | The event captures the edited comments on the community topics. | Event Name: ZDP_COMMUNITY_COMMENT_EDIT Event screen: Topic_Comments Event Data: topic_permalink |
Community | This event captures the number of times the topic's attachment was opened on the topic detail screen. | Event Name: ZDP_ATTACHMENT_PREVIEW Event screen: Topic_Detail/Topic_Comments Event Data: permalink |
Community | This event captures the number of times the article's attachment was downloaded on the topic detail screen. | Event Name: ZDP_ATTACHMENT_DOWNLOAD Event screen: Topic_Detail/Topic_Comments Event Data: permalink |
Community | This event captures the attachments uploaded to the community topics. | Event Name: ZDP_ATTACHMENT_UPLOAD Event screen: Topic_Editor |
Community | This event captures the attachments deleted from the community topics. | Event Name: ZDP_ATTACHMENT_DELETE Event screen: Topic_Editor/Topic_Comments |
Community | This event captures the community topics added. | Event Name: ZDP_COMMUNITY_TOPIC_ADD Event screen: Topic_Editor Event Data: permalink |
Community | This event captures the community topics previewed. | Event Name: ZDP_COMMUNITY_TOPIC_PREVIEW Event screen: Topic_Editor |
Community | This event captures the community topics drafts added. | Event Name: ZDP_COMMUNITY_DRAFT_ADD Event screen: Topic_Editor |
Community | This event captures the community topics drafts deleted. | Event Name: ZDP_COMMUNITY_DRAFT_DELETE Event screen: Topic_Editor |
Community | This event captures the selected community topic drafts. | Event Name: ZDP_COMMUNITY_DRAFT_SELECT Event screen: Topic_Editor |
Community | This event captures the cancelled community topics. | Event Name: ZDP_COMMUNITY_TOPIC_FORM_CANCEL Event screen: Topic_Editor Event Data: topic_permalink |
Home
Events | Event Description | Event Stats |
Home | This event captures the knowledge base clicks from the home screen. | Event Name: ZDP_HOME_KB_CLICK Event screen: Home |
Home | This event captures the community clicks from the home screen. | Event Name: ZDP_HOME_COMMUNITY_CLICK Event screen: Home |
Home | This event captures the topics add clicks from the home screen. | Event Name: ZDP_HOME_ADD_TOPIC_CLICK Event screen: Home |
Home | This event captures the tickets add clicks from the home screen. | Event Name: ZDP_HOME_SUBMIT_TICKET_CLICK Event screen: Home |
Home | This event captures the guided conversation clicks from the home screen. | Event Name: ZDP_HOME_GC_CLICK Event screen: Home |
Home | This event captures the answer bot clicks from the home screen. | Event Name: ZDP_HOME_ANSWER_BOT_CLICK Event screen: Home |
Home | This event captures the business messaging clicks from the home screen. | Event Name: ZDP_HOME_BM_CLICK Event screen: Home |
Home | This event captures the agent chat clicks from the home screen. | Event Name: ZDP_HOME_AGENT_CHAT_CLICK Event screen: Home |
Home | This event captures the clicks on my tickets from the home screen. | Event Name: ZDP_HOME_TICKETS_LIST_CLICK Event screen: Home |
Home | This event captures the ticket details from the home screen. | Event Name: ZDP_HOME_TICKET_DETAIL_CLICK Event screen: Home Event Data: Ticket_number |
Side Menu
Events | Event Description | Event Stats |
Side Menu | This event captures the chosen knowledge base from the side menu. | Event Name: ZDP_MENU_KB_CLICK Event screen: Modules_Menu |
Side Menu | This event captures the chosen community from the side menu. | Event Name: ZDP_MENU_COMMUNITY_CLICK |
Side Menu | This event captures the chosen topics form from the side menu. | Event Name: ZDP_MENU_ADD_TOPIC_CLICK |
Side Menu | This event captures the submit tickets screen selected from the side menu. | Event Name: ZDP_MENU_SUBMIT_TICKET_CLICK Event screen: Modules_Menu |
Side Menu | This event captures the chosen guided conversations from the side menu. | Event Name: ZDP_MENU_GC_CLICK Event screen: Modules_Menu |
Side Menu | This event captures the chosen answer bots from the side menu. | Event Name: ZDP_MENU_ANSWER_BOT_CLICK Event screen: Modules_Menu |
Side Menu | This event captures the chosen business messaging chats from the side menu. | Event Name: ZDP_MENU_BM_CLICK Event screen: Modules_Menu |
Side Menu | This event captures the chosen agent chats from the side menu. | Event Name: ZDP_MENU_AGENT_CHAT_CLICK |
Side Menu | This event captures my tickets selected from the side menu. | Event Name: ZDP_MENU_TICKETS_CLICK |
Change Language
Events | Event Description | Event Stats |
Language Change | This event captures the language change from the list of languages. | Event Name: ZDP_LANGUAGE_CHANGE Event screen: Languages_List Event Data: en-us |
Launch
Events | Event Description | Event Stats |
Launch | This event captures the launches of the detailed article through the permalink. | Event Name: ZDP_KB_ARTICLE_LAUNCH Event screen: Article_Detail Event Source: Launch_With_Permalink |
Launch | This event captures the launches of tthe knowledge base categories through the permalink. | Event Name: ZDP_KB_CATEGORY_LAUNCH Event screen: Categories_List Event Source: Launch_With_Permalink |
Launch | This event captures the launches of tthe home screen from the application. | Event Name: ZDP_HOME_LAUNCH Event screen: Home |
Launch | This event captures the launches of the knowledge base widgets from the application. | Event Name: ZDP_KB_CATEGORY_LAUNCH Event screen: Categories_List |
Launch | This event captures the launches of the community widgets directly from the application. | Event Name: ZDP_COMMUNITY_CATEGORY_LAUNCH Event screen: Categories_List |
Launch | This event captures the launches of the community topic detail screen from the ID. | Event Name: ZDP_COMMUNITY_TOPIC_LAUNCH Event screen: Topic_Detail Event Source: Launch_With_ID |
Launch | This event captures the launches of the community topic detail screen through the permalink. | Event Name: ZDP_COMMUNITY_TOPIC_LAUNCH Event screen: Topic_Detail Event Source: Launch_With_Permalink |
Launch | This event captures the launches of the community topic added. | Event Name: ZDP_COMMUNITY_ADD_TOPIC_LAUNCH Event screen: Topic_Editor |
Launch | This event captures the launches of the community topic list from the type filter selection.
| Event Name: ZDP_COMMUNITY_TOPICS_LAUNCH Event screen: Topics_List Event Source: Launch_With_Topic_Type Event Data: Discussion/Question |
Launch | This event captures the launches of the community's users' topics. | Event Name: ZDP_COMMUNITY_TOPICS_LAUNCH Event screen: Topics_List Event Source: User_Topics |
Launch | This event captures the launches of tthe MyTickets module directly from the application. | Event Name: ZDP_TICKETS_LIST_LAUNCH Event screen: Tickets_List |
Launch | This event captures the launches of the Submit Ticket module directly from the application. | Event Name: ZDP_TICKETS_ADD_TICKET_LAUNCH Event screen: Department_List |
Launch | This event captures the launches of tthe ticket details from the ID. | Event Name: ZDP_TICKETS_DETAIL_LAUNCH Event screen: Ticket_Detail Events Source: Launch_With_Id |
Launch | This event captures the launches of the ticket list with the status. | Event Name: ZDP_TICKETS_LIST_LAUNCH Event screen: Ticket_List Events Source: Launch_With_Ticket_Status Events Data: open/closed/on-hold |
Additional Events supported on the Android platform:
Events | Event Description | Event Stats |
Knowledge Base | This event captures the number of search clicks from the list of KB categories. | Event Name: ZDP_KB_SEARCH_CLICK Event screen: Categories_List |
Knowledge Base | This event captures the number of times the article's attachment was downloaded from the preview screen. | Event Name: ZDP_ATTACHMENT_DOWNLOAD Event screen: Article_Detail Event Data: article_permalink |
Home | This event captures the search clicks from the home screen. | Event Name: ZDP_HOME_SEARCH_CLICK Event screen: Home |
Community | This event captures the search clicks from the community screen. | Event Name: ZDP_COMMUNITY_SEARCH_CLICK Event screen: Categories_List |
Community | This event captures the number of times the attachment was downloaded from the attachment's preview screen. | Event Name: ZDP_ATTACHMENT_DOWNLOAD Event screen: Topic_Detail/Topic_Comments Event Data: permalink |
Additional Events supported in the iOS platform:
Events | Event Description | Event Stats |
Launch | This event launches the community categories screen from the ID. | Event Name: ZDP_COMMUNITY_CATEGORY_LAUNCH Event screen: Categories_List Event Source: Launch_With_ID |
Takeaway
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Create. Review. Publish.
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho TeamInbox Resources
Zoho DataPrep Resources
Design. Discuss. Deliver.
Related Articles
Introducing ASAP Android SDK
This document pertains explicitly to help widgets created using the updated new ASAP Setup. Please note that if you are using an older version of ASAP, the help widgets will be read-only. To enable the new ASAP widgets on your app, use the latest ...Introducing ASAP iOS SDK
This document pertains explicitly to help widgets created using the updated new ASAP Setup. Please note that if you are using an older version of ASAP, the help widgets will be read-only. To enable the new ASAP widgets on your App, use the latest ...Working with the ASAP Add-Ons for Mobile Platforms
The ASAP SDKs for mobile platforms--iOS and Android--make help available within quick reach for the end-users of your mobile apps. Using these SDKs, you can create and customize add-ons that reside within your app and provide end-users with easy ...Introducing ASAP Flutter Apps SDK
This document pertains explicitly to help widgets created using the updated new ASAP Setup. If you are using an older version of ASAP, the help widgets will be read-only. To enable the new ASAP widgets on your App, use the latest ASAP Flutter Plugin ...Working with the ASAP SDK for Flutter
This document pertains explicitly to help widgets created using the updated new ASAP Setup. If you use an older version of ASAP, the help widgets will be read-only. To enable the new ASAP widgets on your App, use the latest ASAP Flutter Plugin 2.0. ...