Links

Conversion Events

Use our built-in events to track conversion flows and send key event properties to Chartbeat.

Supported events

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.

Subscriptions

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

Registrations

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

Newsletter Signups

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

Event parameters

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.

Examples

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');

Google Analytics Tag Manager

An example of an implementation using a new Tag in Google Analytics Tag Manager linked to an existing Trigger

Piano Composer

Below is an example from Piano Composer:
tp.push(["addHandler", "checkoutComplete", function(conversionData){
chartbeat('trackPaywallComplete');
}]);

Next Steps

Review our integration QA instructions article for best practices.