What would you like to know more about?

Show Page Sections

Configuring My Pledges

Set up the My Pledges widget.

Help people visualize and manage their current pledges. See the Quick Start Guide for tips on getting the My Pledges widget up and running.

If the shared script hasn't been added to your website, add it to the appropriate webpage, replacing "YOUR-BASE-MP-URL" with the base URL with your base MinistryPlatform URL.

<script id="MPWidgets" src="https://YOUR-BASE-MP-URL.com/widgets/dist/MPWidgets.js"></script>

Create or identify a page on your website where you want to display the widget. To add this widget to your church website, add the code you generate in the Widget Configurator widget (with the required attributes) in the body of your chosen website page.

Tip: While not mandatory, this snippet would typically be placed inside a <div> element with the class "container".

Widget Configuration

Optional Attributes

Hide Cancel Button
This determines whether the option to cancel an active pledge displays. The default is true.
  • Attribute: hidecancelbuttonpledge
  • Valid Value: true (or empty) or false
  • Example:
    ​hidecancelbuttonpledge="true"
Cancel Pledge Email Template
The confirmation email sent after a person successfully cancels an active pledge.
Note: If hidecancelbuttonpledge is set to false, then you must set this value.
  • Attribute: cancelpledgeemailtemplate
  • Valid Value: Message record ID (dp_Communications.Communication_ID)
    Tip: This attribute uses a Message ID to send the email. If you don't see your message in the list, you'll need to mark the message to show as an option. If you want to use an existing template, you'll need to convert it to a message first.
  • Example:
    cancelpledgeemailtemplate="1200"

Attributes must be included before the opening widget tag is closed. Attributes may be listed in any order and should be separated by a space or other whitespace. An attribute's value should be wrapped in quotation marks.

<mpp-my-pledges hidecancelbuttonpledge="false" cancelpledgeemailtemplate="1200"></mpp-my-pledges>
Note: This widget is only available to users who have authenticated via the Login Widget. New users have the opportunity to create an account through the Login flow. If needed, the page containing this widget could be added as a navigation item in the Login menu, making it available only after authentication. See Login Configuration for information about extending the drop-down menu.

Configure Your Widget!

Use the Widget Configurator widget to configure your widget:
  1. Go to your Widgets Library by appending "/widgets" to your system domain. For example, https://example-church.ministryplatform.net/widgets.
  2. Click the Navigate to... drop-down menu, and select Widget Configurator.
  3. Select the widget you want to configure, then customize your widget.
  4. Click Try it Out to see what your widget will look like!
  5. Copy the generated code from the Embed Code box.
  6. Add the code to the designated page on your website.

Platform Configuration

To display in the My Pledges widget, pledges must meet the following criteria:

  • Today's date before the end date or the end date is blank.
  • The Show On My Pledges field on the pledge campaign record is set to Yes.
Note: Active or completed pledges continue to display for six months after the campaign's end date. If an image is attached to the pledge campaign in MinistryPlatform, it will display. If there is no image, a stock image will display. File formats supported by both browsers and MinistryPlatform are: .bmp, .gif, .jpg., and .png. The widget software will crop and focus on the center of the image according to an ideal ratio of 59:32.

Mark a Message to Show as an Option

When configuring your widgets, there are fields where you can select an email template. To keep the list manageable, the messages that display as options must be marked as templates.

If the message you want does not display in the Widget Configurator, you can mark it as a template on the message record. (The Template field is hidden by default through System Setup > Field Management, so you'll need to unhide it first.)

  1. Confirm that the message you want is not an option in the Widget Configurator.
  2. In the navigation menu, click System Setup > Field Management.
  3. In the Field Name column, search for Template.
  4. In the Page column, search for Messages.
  5. Open the record, and click Edit Record.
  6. In the Hidden field, select No.
  7. Click Save.
  8. In the navigation menu, click Communications > Messages.
  9. Open the message you want to display as an option in the Widget Configurator, and click Edit Record.
  10. In the Template, select Yes.
  11. Click Save.
  12. Refresh the Widget Configurator if you had it open in your browser .

You can now select this message as an option when you configure the widget.

Convert a Template to a Message

Widgets use message IDs, not template IDs. You can use the Template Editor Tool to create the template you want, but you must turn the template into a message and use that ID in the widget. Here's how!

  1. Create and save your template using the Template Editor Tool. Make sure you can access the template.
  2. Open the New Message Tool, click Insert > Templates, and select your newly created template from the list. Click Send > Save as Draft.
  3. In the navigation menu, click Communications > Messages.
  4. Open the draft you just created.
  5. Click the subject line to open the message record. The Message ID is listed under the subject line.
  6. Use this ID for the Template ID attribute value when you configure the widget.

Customization

Customize the My Pledges widget to change button colors, update labels, and more to match your church brand.

CSS: Every widget accepts the Custom CSS attribute. Include it before the closing of the opening widget tag to customize backgrounds, button colors, and more!

Application Labels: Call them gifts or donations instead of pledges? To make changes, go to System Setup > Application Labels and update the appropriate label(s). Note that you are responsible for all translations if the default is not used.

  • mpp-my-pledges.pageTitle: The page title. The default is "My Pledges".
  • mpp-my-pledges.cancelPledgeButtonText: The text on the Cancel Pledge button. The default is "Cancel Pledge".