Web App Events
Aventus' Customer (Symphony) and B2B (Opus) Portal's are currently delivered as Single-Page Applications (SPAs) which makes tracking some actions/events difficult. To support better tracking, both portal's have native integration with Google Tag Manager. This page documents additional events supported to allow for tagging and tracking capabilities to be enhanced.
Event Wrapper
All events are wrapped with the following payload
{
"app": "symphony", // or "opus"
"appVersion": "1.0.0", // string representation of build verison
"event": "aventus.eventname", // string event name (all prefixed with aventus.)
// ... Event payload
}
Policy Events
aventus.policy.bind
aventus.policy.bind
When the quote has been bound as a policy (purchased)
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.policy.bind",
"partnerId": "00000000-0000-0000-0000-000000000000", // optional
"partnerReference": "example-reference-1", // optional
"policyId": "00000000-0000-0000-0000-000000000000",
"partnerId": "00000000-0000-0000-0000-000000000000", // optional
"productCoverReference": "comprehensive"
"policyGross": 120.34 // Value of policy
//...
}
aventus.policy.view
aventus.policy.view
When the summary screen of a policy has been viewed
NB: This currently only triggers immediately after the purchase of a policy
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.policy.bind",
"policyId": "00000000-0000-0000-0000-000000000000",
"productCoverReference": "comprehensive"
//...
}
Quote Events
aventus.quickquote.start
aventus.quickquote.start
Start quickquote journey
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quickquote.start",
"quoteId": "00000000-0000-0000-0000-000000000000",
"partnerId": "00000000-0000-0000-0000-000000000000", // optional
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
aventus.quote.additionalQuestionsStarted
aventus.quote.additionalQuestionsStarted
Additional question set started
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.aditionalQuestionsStarted",
"quoteId": "00000000-0000-0000-0000-000000000000",
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
aventus.quote.additionalQuestionsAnswered
aventus.quote.additionalQuestionsAnswered
Additional question set completed (answered)
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.additionalQuestionsAnswered",
"quoteId": "00000000-0000-0000-0000-000000000000",
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
aventus.quote.confirm
aventus.quote.confirm
Quote is confirmed
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.confirm",
"quoteId": "00000000-0000-0000-0000-000000000000", // optional
"partnerId": "00000000-0000-0000-0000-000000000000", // optional
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
aventus.quote.converted
aventus.quote.converted
User tries to load a converted quote
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.converted",
"quoteId": "00000000-0000-0000-0000-000000000000",
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
aventus.quote.customise
aventus.quote.customise
Land on customisation screen of quote flow
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.customise",
"quoteId": "00000000-0000-0000-0000-000000000000", // optional
"partnerId": "00000000-0000-0000-0000-000000000000", // optional
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
aventus.quote.decline
aventus.quote.decline
A quote is declined after completing the quote questions (on the customisation screen)
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.decline",
"quoteId": "00000000-0000-0000-0000-000000000000", // optional
"partnerId": "00000000-0000-0000-0000-000000000000", // optional
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
aventus.quote.expired
aventus.quote.expired
User tries to load an expired quote
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.expired",
"quoteId": "00000000-0000-0000-0000-000000000000",
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
aventus.quote.questionSetPage
aventus.quote.questionSetPage
A new question set page is loaded
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.questionSetPage",
"pageTitle": "About you", // Full string of page title,
"pageNumber": 2, // Page number in sequence
"pageHash": "about-you", // 'slugified' pageTitle used in url eg #about-you
"quoteId": "00000000-0000-0000-0000-000000000000", // optional
"partnerId": "00000000-0000-0000-0000-000000000000", // optional
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
aventus.quote.riskUpdated
aventus.quote.riskUpdated
When a risk value is updated
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.riskUpdated",
"quoteId": "00000000-0000-0000-0000-000000000000",
"partnerId": "00000000-0000-0000-0000-000000000000", // optional
"riskPath": "proposer.name", // full risk path (json notation)
"oldValue": null, // Could be any type - or null when no value previously
"newValue": true // Could be any type
//...
}
aventus.quote.saved
aventus.quote.saved
Quote save button is pressed
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.start",
"quoteId": "00000000-0000-0000-0000-000000000000", // optional
"partnerId": "00000000-0000-0000-0000-000000000000", // optional
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
aventus.quote.start
aventus.quote.start
Starting quote journey
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.start",
"quoteId": "00000000-0000-0000-0000-000000000000", // optional
"partnerId": "00000000-0000-0000-0000-000000000000", // optional
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
aventus.quote.view
aventus.quote.view
User views a confirmed quote
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.quote.start",
"quoteId": "00000000-0000-0000-0000-000000000000",
"productReference": "avt_pr_product_reference",
"productCoverReference": "comprehensive"
//...
}
Misc Events
aventus.screenview
aventus.screenview
Fires each time a unique screen view is loaded, sequential screen loads of the same screen do not fire additional screenviews.
This event has a single additional property, view
, which is the label of the screen shown. The screens used are detailed below.
Example Payload
{
"app": "symphony",
"appVersion": "1.0.0",
"event": "aventus.screenview",
"view": "Checkout", // String name of the view being viewed/loaded
//...
}
Screens
Screen Name | Description |
---|---|
Checkout | Main checkout screens |
IntelligentQuickQuote | QuickQuote summary screen |
IntelligentQuoteAsk | Quote question screen |
IntelligentQuoteDecline | Quote declined screen |
IntelligentQuoteExpiredOrConverted | Quote expired or converted screen |
IntelligentQuoteSummary | Quote Summary screen |
ProductOverview | Overview of product, before quote screens |
PolicyCancelAgentRequired | Policy cancel screen when agent cancellation is required |
VriMissingData | VRI Flow missing data screen |
VriSummary | VRI Flow summary/overview screen |
sign-in | Sign in screen |
sign-up | Sign up screen |
Updated over 3 years ago