---
title: Web Tracking Events
slug: connect/web-tracking-events
docTags:
createdAt: 2023-11-28T09:25:51.876Z
---
# Event structs
| **Property** | **Description** |
| ------------ | ------------------------------------------------------------------- |
| eventName | Event name |
| payload | Payload, The payload structure may vary depending on the event name |
# All Web events name
| **Event Name** | **Payload** | **Description** |
| ----------------------------------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------- |
| app\_loaded | | The app loaded |
| page\_view | | Page exposure |
| page\_duration | | page duration |
| landing\_continue\_click | | Click the continue button on the landing page |
| landing\_exit\_click | | Click the exit button on the landing page |
| landing\_terms\_click | | Click the terms link on the landing page |
| landing\_privacy\_policy\_click | | Click the privacy policy link on the landing page |
| institution\_list\_back\_click | | Click the back button on the institution list page |
| institution\_list\_exit\_click | | Click the exit button on the institution list page |
| institution\_list\_citizen\_portal\_click | | Click the citizen portal button on the institution list page |
| institution\_list\_search | key | Search for institutions on the institution list page |
| institution\_click | institutionCode
institutionName | Click to select an institution on the institution list page |
| data\_confirmation\_back\_click | institutionCode
institutionName | Click the back button on the data confirmation page |
| data\_confirmation\_exit\_click | | Click the exit button on the data confirmation page |
| data\_confirmation\_continue\_click | institutionCode
institutionName | Click the continue button on the data confirmation page |
| data\_confirmation\_validity\_click | institutionCode
institutionName | Click the validity link on the data confirmation page |
| data\_confirmation\_klavi\_portal\_click | institutionCode
institutionName | Click the klavi link on the data confirmation page |
| authorise\_success | institutionCode
institutionName
institutionType | Authorise success |
| authorise\_success\_connect\_more\_click | institutionCode
institutionName | Click the connect more account button on the authorise success page |
| authorise\_success\_finish\_click | institutionCode
institutionName | Click the finish button on the authorise success page |
| authorise\_fail | institutionCode
institutionName
institutionType | Authorise error |
| authorise\_fail\_retry\_click | institutionCode
institutionName | Click the try again button on the authorise error page |
| authorise\_fail\_connect\_another\_click | institutionCode
institutionName | Click the connect another account button on the authorise error page |
| authorise\_fail\_exit\_click | institutionCode
institutionName | Click the exit button on the authorise error page |
| unavailable\_connect\_another\_click | institutionCode
institutionName | Click the connect another account button on the unavailable page |
| unavailable\_cancel\_click | institutionCode
institutionName | Click the exit button on the unavailable page |
| credentials\_back\_click | institutionCode
institutionName | Click the back button on the credentials page |
| consent\_limit\_connect\_another\_click | institutionCode
institutionName | Click the connect another account button on the consent limit reached page |
| consent\_limit\_exit\_click | institutionCode
institutionName | Click the exit button on the consent limit reached page |
| credentials\_exit\_click | | Click the back exit button on the credentials page |
| credentials\_connect\_click | institutionCode
institutionName | Click the connect button on the credentials page |
| mfa\_show | institutionCode
institutionName
mfaId
mfaType | Show the MFA popup |
| mfa\_ok\_click | institutionCode
institutionName
mfaId
mfaType | Click the ok button on the MFA popup |
| mfa\_cancel\_click | institutionCode
institutionName
mfaId
mfaType | Click the cancel button on the MFA popup |
# Some common properties of payload
| **Property** | **Description** |
| --------------- | --------------------------------------------------------------------------- |
| eventId | The event id |
| eventTime | The event time |
| linkId | Link identify |
| partnerAppId | The partner applicaton identify |
| partnerCode | The partner code |
| partnerName | The partner name |
| institutionCode | The institution code |
| institutionName | The institution name |
| key | Filter keywords for `institution_list_search` event |
| mfaId | The mfaId for events `mfa_show` , `mfa_ok_click` , `mfa_cancel_click` |
| mfaType | The mfaType for events `mfa_show` , `mfa_ok_click` , `mfa_cancel_click` |
Example:
```json
{
"eventName":"data_confirmation_continue_click",
"payload":{
"eventId":"1495468585434-0e73d1719173766fe4dfe1a8",
"eventTime":"2022-06-25T20:08:17.848Z",
"linkId":"ed812-81fcec-7ec55-7aa7d29-2a3188b75",
"partnerAppId":"kidemobw_standard",
"partnerCode":"a12882js781s",
"partnerName":"kidemo",
"institutionCode":"260",
"institutionName":"Nubank",
}
}
```
# Event example
:::ExpandableHeading
## page\_view event
When the page is accessed, the `page_view` event will be triggered.
```json
{
"eventName":"page_view",
"payload":{
"eventId":"1495468585434-0e73d1719173766fe4dfe1a8",
"eventTime":"2022-06-25T20:08:17.848Z",
"linkId":"ed812-81fcec-7ec55-7aa7d29-2a3188b75",
"partnerAppId":"yourappid",
"partnerCode":"a12882js781s",
"partnerName":"yourpartner",
"name:": "dataConfirmation",
"url":"https://open-testing.klavi.ai/link/data-confirmation/001",
"path": "/link/data-confirmation/001",
"width": 1920,
"height": 1000,
}
}
```
:::
:::ExpandableHeading
### page\_view properties of payload
| **Property** | **Description** |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | The name of the page. Optional values are `landingPage` `institutionList` `dataConfirmation` `redirection` `success` `fail` `unavailable` `consentLimitReached` `credentials` `loading` |
| url | The url address of the current page |
| path | The path of the current page |
| width | The viewable width of end user access device |
| height | The viewable height of end user access device |
## page\_duration event
The `page_duration` event record how long users stay on the current page.
### page\_duration properties of payload
| **Property** | **Description** |
| ------------ | --------------------------------------------- |
| name | The page name |
| durationTime | The page duration time, value in milliseconds |
:::
:::ExpandableHeading
## loading\_continue\_click event
Click the Continue button on the data confirmation page to trigger the `landing_continue_click` event.
```json
{
"eventName":"landing_continue_click",
"payload":{
"eventId":"1495468585434-0e73d1719173766fe4dfe1a8",
"eventTime":"2022-06-25T20:08:17.848Z",
"linkId":"ed812-81fcec-7ec55-7aa7d29-2a3188b75",
"partnerAppId":"yourappid",
"partnerCode":"a12882js781s",
"partnerName":"yourpartner",
}
}
```
:::
:::ExpandableHeading
## institution\_click event
Select an institution in the institution list to trigger the `institution_click`event.
```json
{
"eventName":"institution_click",
"eventTime":"2022-06-25T20:08:17.848Z",
"payload":{
"eventId":"1495468585434-0e73d1719173766fe4dfe1a8",
"eventTime":"2022-06-25T20:08:17.848Z",
"linkId":"ed812-81fcec-7ec55-7aa7d29-2a3188b75",
"partnerAppId":"yourappid",
"partnerCode":"a12882js781s",
"partnerName":"yourpartner",
"institutionCode":"260",
"institutionName":"Nubank"
}
}
```
:::
:::ExpandableHeading
## authorise\_success event
User authorization successfully triggers `authorise_success` event
```json
{
"eventName":"authorise_success",
"payload":{
"eventId":"1495468585434-0e73d1719173766fe4dfe1a8",
"eventTime":"2022-06-25T20:08:17.848Z",
"linkId":"ed812-81fcec-7ec55-7aa7d29-2a3188b75",
"partnerAppId":"yourappid",
"partnerCode":"a12882js781s",
"partnerName":"yourpartner",
"institutionCode":"260",
"institutionName":"Nubank"
}
}
```
:::
:::ExpandableHeading
## authorise\_error event
User authorization successfully triggers `authorise_error` event
```json
{
"eventName":"authorise_error",
"payload":{
"eventId":"1495468585434-0e73d1719173766fe4dfe1a8",
"eventTime":"2022-06-25T20:08:17.848Z",
"linkId":"ed812-81fcec-7ec55-7aa7d29-2a3188b75",
"partnerAppId":"yourappid",
"partnerCode":"a12882js781s",
"partnerName":"yourpartner",
"institutionCode":"260",
"institutionName":"Nubank"
}
}
```
:::