Parameters

Explore Fundraise Up’s JavaScript API events and parameters

Fundraise Up fires three JavaScript events based on the state of Checkout: checkoutOpen, checkoutClose, and donationComplete. Whenever an event is fired, available parameters and their values are sent to the JavaScript data layer. The parameters for each event are described in this article.

checkoutOpen

This event is fired every time Checkout is opened.

Parameter Type Description
customfields.[parameters] String An array containing the names and values for any custom fields added to the campaign
livemode Boolean Set to true if test mode was not used for the donation.
campaign.id String The alphanumeric Fundraise Up campaign ID
campaign.code String The code assigned to the campaign. No value if parameter value is not provided
campaign.name String The name of the campaign
utm.source String The source parameter value if a source property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.campaign String The source parameter value if a campaign property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.medium String The source parameter value if a medium property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.content String The source parameter value if a content property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.term String The source parameter value if a term property is included in the URL that launched Checkout. No value if parameter value is not provided
element.id String The alphanumeric Fundraise Up ID of the Elements component used to launch Checkout. No value if parameter value is not provided
element.type String The type of Elements component (e.g. Donate Button) used to launch Checkout.
element.name String The name of the Elements component used to launch Checkout.

checkoutClose

This event is fired any time Checkout is closed, regardless of whether a conversion has been logged.

Parameter Type Description
customfields.[parameters] String An array containing the names and values for any custom fields added to the campaign
livemode Boolean Set to true if test mode was not used for the donation.
campaign.id String The alphanumeric Fundraise Up campaign ID
campaign.code String The code assigned to the campaign. No value if parameter value is not provided
campaign.name String The name of the campaign
utm.source String The source parameter value if a source property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.campaign String The source parameter value if a campaign property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.medium String The source parameter value if a medium property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.content String The source parameter value if a content property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.term String The source parameter value if a term property is included in the URL that launched Checkout. No value if parameter value is not provided

donationComplete

This event fires at the point of conversion in Checkout.

Parameter Type Description
customfields.[parameters] String An array containing the names and values for any custom fields added to the campaign
livemode Boolean Set to true if test mode was not used for the donation.
campaign.id String The campaign ID
campaign.code String The code assigned to the campaign. No value if parameter value is not provided
campaign.name String The name of the campaign
utm.source String The source parameter value if a source property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.campaign String The source parameter value if a campaign property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.medium String The source parameter value if a medium property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.content String The source parameter value if a content property is included in the URL that launched Checkout. No value if parameter value is not provided
utm.term String The source parameter value if a term property is included in the URL that launched Checkout. No value if parameter value is not provided
element.id String The ID of the Elements component used to launch Checkout. No value if parameter value is not provided
element.type String The type of Elements component (e.g. Donate Button) used to launch Checkout.
element.name String The name of the Elements component used to launch Checkout.
supporter.id String The alphanumeric Fundraise Up supporter ID of the the donor
supporter.email String The supporter’s email address
supporter.firstName String The supporter’s first name
supporter.lastName String The supporter’s last name
supporter.anonymous Boolean If the Donate anonymously option is enabled for Checkout, the value will be true if the option is selected, and false if the option is not selected
supproter.mailingListSubscribed Boolean If the mailing list feature is enabled for Checkout, the value is true if the option is selected, and false when the option is not selected
supporter.employer String If the company matching feature is enabled for Checkout and a supporter inputs a value, the value is stored for the supporter.employer parameter, otherwise, the value is null
supporter.onBehalfOf String If the option to donate on behalf of an organization is enabled for Checkout and a supporter inputs a value, the value is stored for the supporter.onBehalfOf parameter, otherwise, the value is null
donation.id String The alphanumeric Fundraise Up donation ID
donation.paymentMethod String The payment method used at checkout. Options: creditCard, paypal, applePay, googlePay, clickToPay, ach, plaid, acss, ukBacs, auBecsDebit, sepa, venmo, iDEAL
donation.amount Number The total donation amount, including transaction fees
donation.feesCovered Number The fee amount assessed for the donation
donation.currency String The currency selected at checkout
donation.recurring Boolean true if a recurring frequency was selected at checkout, false if a one-time donation was made
donation.frequency String The donation frequency selected at checkout. Options: once, Daily, Weekly, Biweekly, Monthly, Bimonthly, Quarterly, Semiannual, Annual
designation.id String The alphanumeric Fundraise Up identifier of the designation selected at checkout. No value if parameter value is not provided
designation.name String The name of the designation selected at checkout. No value if parameter value is not provided
designation.code String The alphameric code of the designation selected at checkout. No value if parameter value is not provided
tribute.type Boolean If the tribute feature is enabled and a supporter selected the option during checkout, no value is assigned. If the option was not selected, the value is null

Using parameters

The most common use case for Fundraise Up’s JavaScript API is pushing data to marketing and analytics tools using Google Tag Manager. The JavaScript API can also be used to integrate Fundraise Up with other third-party platforms.

More resources

Explore how-to guides for integrating Fundraise Up with other apps and services using the JavaScript API.


Examples

Explore Fundraise Up’s JavaScript API using test mode to trigger events and view data in the JavaScript console.

Related articles
JavaScript
API

 

In this article