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

Unsubscribes

Track unsubscribe activity on your site.

Event Name	Description	Requirement
trackUnsubscribeShown	A user visited an unsubscribe page	Optional
trackUnsubscribeStart	A user started an unsubscribe flow	Optional
trackUnsubscribeComplete	A user unsubscribed	Required
trackUnsubscribeCancel	A user dismissed an unsubscribe flow	Optional

Offers

Track offer activity on your site.

Event Name	Description	Requirement
trackOfferShown	A user was shown an offer	Optional
trackOfferStart	A user started an offer	Optional
trackOfferComplete	A user completed an offer	Required
trackOfferCancel	A user dismissed an offer	Optional

Surveys

Track survey activity on your site.

Event Name	Description	Requirement
trackSurveyShown	A user was shown a survey	Optional
trackSurveyStart	A user started a survey	Optional
trackSurveyComplete	A user completed a survey	Required
trackSurveyCancel	A user dropped off a survey	Optional

Account Creations

Track user profile activity (e.g. filling out text fields) on your site.

Event Name	Description	Requirement
trackUserProfileShown	A user viewed their profile	Optional
trackUserProfileStart	A user started editing their profile	Optional
trackUserProfileComplete	A user completed editing to their profile	Required
trackUserProfileCancel	A user exited profile-editing mode	Optional

Downloads

Track download activity (e.g. pdf case studies, apps) on your site.

Event Name	Description	Requirement
trackDownloadStart	A user started downloading data	Optional
trackDownloadComplete	A download has completed	Required
trackDownloadCancel	A download was canceled	Optional

Donations

Track donation activity on your site.

Event Name	Description	Requirement
trackDonationShown	An option to donate was shown	Optional
trackDonationStart	A user started the donation process	Optional
trackDonationComplete	A user completed the donation process	Required
trackDonationCancel	A user canceled the donation process	Optional

Payments

Track payment activity on your site (other than payment for a subscription).

Event Name	Description	Requirement
trackPaymentStart	A user started a payment process	Optional
trackPaymentComplete	A user completed a payment process	Required
trackPaymentCancel	A user canceled a payment process	Optional

Searches

Track completed search queries on your site.

Event Name	Description	Requirement
trackSearchComplete	A user performed a search	Required

Saves

Track save activity (e.g. a user added an item to their "Favorites" collection) on your site.

Event Name	Description	Requirement
trackSaveComplete	A user saved an item for future retrieval	Required

Call the chartbeat() function

Once you've added the subscriptions.js snippet to your webpages, call the global chartbeat() function to track subscription events — with or without optional parameters.

chartbeat('event_name', { // CHANGE THIS TO THE SUPPORTED EVENT YOU WANT TO TRACK
    pathOverride, // optional
    eventLabel, // optional
    eventValue, // optional
} )

Track activity related to offers on your site.

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.