Conversion Events
Use our built-in events to track conversion flows and send key event properties to Chartbeat.
Below is a list of the event methods you can pass to the
chartbeat() function, followed by a list of optional parameters you can send with each method. You should fire a Chartbeat event from the same category on every page in a single conversion flow. Track paywall activity and subscription transactions on your site.
Event Name | Description | Requirement |
trackPaywallShown | A user was shown a paywall | Required |
trackPaywallStart | A user started a subscription process | Optional |
trackPaywallComplete | A user completed a subscription transaction | Required |
trackPaywallCancel | A user canceled a subscription process | Optional |
Track registration activity (i.e. users creating an account) on your site.
Event Name | Description | Requirement |
trackRegistrationShown | A user viewed a registration screen | Required |
trackRegistrationStart | A user started the registration process | Optional |
trackRegistrationComplete | A user completed the registration process | Required |
trackRegistrationCancel | A user canceled the registration process | Optional |
Track newsletter signup activity on your site.
Event Name | Description | Requirement |
trackNewsletterSignupShown | A user was shown a newsletter signup option | Required |
trackNewsletterSignupStart | A user started a signup process | Optional |
trackNewsletterSignupComplete | A user completed a signup process | Required |
trackNewsletterSignupCancel | A user canceled a signup process | Optional |
There are 3 optional parameters you can send with each event:
Optional Parameter | Type | Default | Description |
pathOverride | string | null | Set a path different from the one sent by your standard configuration (not recommended) |
eventLabel | string | null | Set a label (e.g. monthly or annual subscription package) |
eventValue | number | null | Set a value (e.g. the price of the subscription package) |
Optional event parameters are not currently surfaced in any Chartbeat product.
Here is a basic example that you would add to your paywall's "Complete" event handler:
// Add to your Paywall Complete event handler
chartbeat('trackPaywallComplete');
An example of an implementation using a new Tag in Google Analytics Tag Manager linked to an existing Trigger
tp.push(["addHandler", "checkoutComplete", function(conversionData){
chartbeat('trackPaywallComplete');
}]);
Review our integration QA instructions article for best practices.
Last modified 3mo ago