Fundraiser Tracker Reference

The fundraiser tracker shows the progress of your fundraiser and allows linking to your fundraiser or launching a fundraiser embedded on your website. This reference explains all the attributes that can be added to the embed code to modify its behavior.

Embedding Fundraiser Trackers Learn how to embed fundraiser trackers.

Parameters

data-partner-key (required)

type: string

Your partner key

<div class="plg-goal" data-partner-key="[PARTNER KEY]"></div>

data-item-id

type: string

Your fundraiser ID

<div class="plg-goal"
  data-partner-key="deda3c2373fff7a1ee87f09e57684fad"
  data-item-id="[FUNDRAISER ID]"></div>

data-show-donate-action

type: boolean|string of value link default: false

Shows a “Donate” button on the tracker. If set to link, the button will open your fundraiser in a new tab. If set to true, the button will send a message to your frame via postMessage and it will be up to your page to handle it.

<div class="plg-goal"
  data-partner-key="deda3c2373fff7a1ee87f09e57684fad"
  data-item-id="34261ed93c4699a7cf5b5b1e5f11fa78"
  data-show-donate-action="link"></div>

postMessage event

When show-donate-action is set to true and the “Donate” button is clicked, it will send a message to your frame via postMessage with the following stringified JSON. Be sure to parse the JSON before using it.

{
  "action": "donate",
  "data": {
    "itemId": "34261ed93c4699a7cf5b5b1e5f11fa78"
  }
}

data-show-change-action

type: boolean default: false

Renders widget in “creator” mode with a “change” button. This is used to show a summary of a user’s fundraiser with the ability to modify it. When the button is clicked, it will send a message to your frame via postMessage signaling that you should show the fundraiser edit UI to the user.

<div class="plg-goal"
  data-partner-key="deda3c2373fff7a1ee87f09e57684fad"
  data-item-id="34261ed93c4699a7cf5b5b1e5f11fa78"
  data-show-change-action="true"></div>

postMessage event

When the “change” button is clicked, it will send a message to your frame via postMessage with the following stringified JSON. Be sure to parse the JSON before using it.

{
  "action": "changeBeneficiary",
  "data": {
    "itemId": "34261ed93c4699a7cf5b5b1e5f11fa78"
  }
}

data-show-active-totals

type: boolean default: false

Shows the amounts raised only for the currently configured nonprofit organizations for the fundraiser and excludes any amounts raised for nonprofit organizations that were but no longer are a part of the fundraiser.

<div class="plg-goal"
  data-partner-key="deda3c2373fff7a1ee87f09e57684fad"
  data-item-id="34261ed93c4699a7cf5b5b1e5f11fa78"
  data-show-active-totals="true"></div>