DEVELOPER GUIDE
WhiteLabel Web Tracking
Web Tracking Events
7 min
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 { "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 page view event when the page is accessed, the page view event will be triggered { "eventname" "page view", "payload" { "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtime" "2022 06 25t20 08 17 848z", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "partnerappid" "kidemobw standard", "partnercode" "a12882js781s", "partnername" "kidemo", "name " "dataconfirmation", "url" "https //conecte testing klavi tech/link/data confirmation/001", "path" "/link/data confirmation/001", "width" 1920, "height" 1000, } } if you were a klavi customer before 22/11/2024, you may be able to use the links according to the old nomenclature, then, the url may look like https //open testing klavi tech/link/data confirmation/001 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 loading continue click event click the continue button on the data confirmation page to trigger the landing continue click event { "eventname" "landing 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", } } institution click event select an institution in the institution list to trigger the institution click event { "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" "kidemobw standard", "partnercode" "a12882js781s", "partnername" "kidemo", "institutioncode" "260", "institutionname" "nubank" } } authorise success event user authorization successfully triggers authorise success event { "eventname" "authorise success", "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" } } authorise error event user authorization successfully triggers authorise error event { "eventname" "authorise error", "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" } }