About

Events are implemented through the personeticsEvent (mobile) and widgetEvent (web) functions.

Events are triggered by Personetics widgets upon widget specific occurrences, such as teaser widget is clicked, story widget is closed, etc. These events are managed by the customer.

Two types of events are available, where some of the events both types:

Reporting - used for analysis of user interaction
Action events - require a program response or action by the bank. For example, teaserClick action event requires an action by the bank's app such as opening the corresponding insight story using startWidget.

Reporting Events

Reporting events are generated when a user performs an action, and can be used by the bank to define response to the action, where some events may be used for analytics or statistics. Reporting events (along with Action events described in the Client API), are triggered by the personeticsEvent function (for mobile), and widgetEvent function (for web).

Each event is labeled by the eventId (e.g. teaserClick), and includes event identification information. (Not all the event identification items are relevant for every event.)

Event example - singleTeaser

{
"eventType": "reporting",
"widgetType": "singleTeaser",
"eventId": "teaserClick"
"eventData": {
"eventDateTime": "01/03/2019 11:24:54",
"value": "1",
"insightId": "NotifyLargeDeposit",
"instanceId": "38554f7a-dd00-4d3f-ad43-450147994a20",
"useCaseId": "NotifyLargeDeposit_UC1",
}
}

Event description and identification information

Name	Description
eventType	Defined as 'reporting'.
widgetType	Type of widget: singleTeaser, carousel, hub, trackerDashboard, inbox
eventId	Reporting event name.
eventData	Contains relevant event information: eventDateTime - event timestamp. value - number of listed insights. For singleTeaserWidget, this will alwaysbe '1'. insightId - unique name of insight generating the event. instanceId - each insight instance has a unique Id.

Note: *InsightId and InstanceId returns inversed values. Known limitation

Teaser Widgets Events

The following events are generated by teaser widgets. Note that not all events are relevant to all teasers.

WidgetStarted Events

EventId	Description	Widgets
singleTeaserWidgetStarted	singleTeaser widget started	singleTeaser
inboxWidgetStarted	inbox widget started	inbox, carousel
carouselWidgetStarted	Carousel widget opened	carousel
hubWidgetStarted	hub widget opened	hub
trackersDashboardWidgetStarted	trackersDashboard widget opened	trackersDashboard

Following are examples of WidgetStarted Events. The structure for all widgets is the same, where the widgetType is set according to the widget name.

"eventType": "reporting",
"widgetType": "singleTeaser",
"eventId": "singleTeaserWidgetStarted"
"eventData": {
"eventDateTime": "01/03/2019 11:24:54",
"value": "1"

}
}

{
"eventType": "reporting",
"widgetType": "inbox ",
"eventId": "inboxWidgetStarted"
"eventData": {
"eventDateTime": "01/03/2019 11:24:54",
"value": "3", //number of insights. No insights list at this stage

}
}

{
"eventType": " reporting ",
"widgetType": "carousel",
"eventId": "inboxWidgetStarted"
"eventData": {
"eventDateTime": "01/03/2019 11:24:54",
"value": "3", //number of insights. No insights list at this stage

}
}

Click and Swipe Events

EventId	Description	Widgets
teaserClick	user clicked on teaser	singleTeaser, inbox, carousel, hub
button	user clicked on button	inbox, carousel, hub
carouselSwipe	user swiped on carousel	carousel, hub
carouselClick	User clicked on the next teaser / chevron on carousel	carousel, hub
trackerClick	user clicked on a tracker	hub, trackersDashboard

Following are some examples of click events, and the carousel swipe event.

{
"eventType": "reporting",
"widgetType": "singleTeaser",
"eventId": "teaserClick"
"eventData": {
"eventDateTime": "01/03/2019 11:24:54",
"value": "1",
"insightId": "NotifyLargeDeposit",
"instanceId": "38554f7a-dd00-4d3f-ad43-450147994a20",
"useCaseId": "NotifyLargeDeposit_UC1",
}
}

{
"eventType": "reporting",
"widgetType": "inbox ",
"eventId": "inboxWidgetStarted"
"eventData": {
"eventDateTime": "01/03/2019 11:24:54",
"value": "3", //number of insights. No insights list at this stage

}
}

story-widget Reporting Events

The listed events are only relevant to the story-widget

EventId	Description	Possible Value	Code
navigateButton	Navigation button clicked
feedback	User submits feedback on rating widget
rating	User submits rating on rating widget
backButtonClicked	user closed story by clicking the back arrow
errorOccured	client error occurred
quiz	Trivia radio button - clicked
barChartBarClick	User clicked on a bar in the bar chart
barChartPickerClick	Bar-chart month-picker, month click
comparableBarChartBarClick	Bar-chart comparison bar click
comparableBarChartPickerClick	user clicked on month to month comparison picker on bar-chart
calendar	user clicked on calendar search
entitySelectorClick	Entity Selector entity clicked
entitySelectorSwipe	entity selector, entity swiped
entitySelectorChevron	chevron on entity selector clicked
pieChartSlice	pie chart slice clicked
pieChartChevron	Pie chart Chevron clicked
tabs	tabs block clicked
triviaCorrect	user answered a trivia answer correctly
triviaIncorrect	Incorrect trivia response
accountSelectorChevron	Account selector chevron clicked
accountSelectorSwipe	All or specific account swiped
account-selector	All or specific account selected
OpenTransactionUpdate	User opened the transaction modal
TransactionCategoryUpdateSingle	User applies a different category to a single transaction
TransactionCategoryUpdate	User decided to apply a different category on all transactions committed to a specific merchant
TransactionPersonalTagUpdateSingle	User tags a single transaction
TransactionPersonalTagUpdate	User decided to tag all transactions committed to a specific merchant
linkNavigation	User clicked on a link
Filter	User used a filter option

Budget Reporting Events

Event ID	Description
budgetWidgetStarted	Budget widget started
recommendedBudgetApproved	User clicked on the approve recommended budget button on manage budget
recommendedBudgetChanged	user changed the amount of the budget recommendation
newBudget	User added a budget
updateBudget	User updated existing budget amount
deleteBudget	User stopped a budget

ACT Reporting Events

The following events are supported by both ACT widgets: actOnboarding, and actManagement

Event ID	Description	Widgets
externalNavigation	User wished to be navigated to an external (out of the widget) page	actOnboarding, actManagement
refershInsights	User performed action/s that requires insight regeneration	actOnboarding, actManagement

Action Events

EventId	Description	Widgets
teaserClick		singleTeaser, singleTrackerTeaser, inbox, carousel, story-widget
callPersoneticsAPI (update user data assets)		inbox, carousel, story-widget
navigateToPage	User clicked on a navigation button requiring access to another page. For example, to manage-budgets - requires opening a new manage-budgets widget	carousel, story-widget, actManagement, actOnboarding
refreshInsights	Raised by the widget when user closes the story after updating a transaction using the modal. The bank’s application should call getInsights again. JSON {"eventType":"refreshInsights"}	story-widget, actManagement, actOnboarding