What would you like to know more about?

Quick Start for Widgets

What you need to know to set up widgets, including steps to set up shared configuration.

You can add widgets to a website with very little coding knowledge, but widgets do live on websites! You must work with your web staff or vendor to successfully integrate widgets into your existing website. See Specific CMS Tips for your Content Management System.

To configure widgets on your website, complete the steps for shared configuration (script and permitted URLs), and then check out the steps tp configure each specific widget (code snippet and attributes).

Tip: Want to walk through the initial setup and see how to add a widget? Check out the Adding Widgets webinar in the MinistrySmart Academy!

Set Up Shared Configuration

The five-step process to set up shared widget configuration.

All widgets are powered by a shared script that you must add to any page where you want to use a widget. While some widgets can have additional optional elements like filtering by attributes or URL, you can generally configure a widget with the same basic steps. When in doubt, use the Widget Configurator widget!
Tip: Add the shared script to your website header to make widgets available on all pages of your website!
Important: The information displayed in your widgets comes directly from MinistryPlatform. Make sure the relevant MinistryPlatform records are correct and up to date with names, titles, dates, descriptions, and so on.
1. Set Permitted URLs
  1. In your permitted URLs list, add any website where you place a widget. Contact Support to add, change, or remove permitted URLs.
    Important: Permitted URLs are case-sensitive, so make sure you add both uncapitalized and capitalized versions of your URLs to your permitted URL list. For example, both www.ministryplatform.com and www.MinistryPlatform.com are both permitted URLs.

    Looking for more details? See Enabling Widgets for an in-depth description.

2. Enable Widgets on Your Website
  1. Find your church's base MinistryPlatform URL.
    If your MinistryPlatform URL is https://example-church.ministryplatform.net/mp, your base URL would be https://example-church.ministryplatform.net.
  2. In in the following code box, replace "YOUR-BASE-MP-URL" with your actual base MinistryPlatform URL.
    <script id="MPWidgets" src="https://YOUR-BASE-MP-URL.com/widgets/dist/MPWidgets.js"></script>
  3. Copy the code.
  4. Add your shared script to the website header using your church's website management software (CMS). If you can't do this in your CMS, add the script to any page that will have widgets.
3. Identify or Create Your Webpage
  1. Identify where on your website you want widgets to display.

    Some widgets are foundational, like the Login and Language & Locale widgets, and you may want to display them on every page. Other widgets may live on specific pages, like the Event Finder widget on an events page.

4. Configure Your Widget
  1. Add a widget to the page.
  2. Configure the widget with the target URL.
  3. Review and configure any additional options for the widget.
5. Configure Your MinistryPlatform Records
  1. Ensure your widgets are all accurate. Each widget needs its own MinistryPlatform configuration.
    Tip: Want users to filter by campus? Make sure your congregations have the Available Online field set to Yes. Want to filter by ministry? Make sure the appropriate ministries have the Available Online field set to Yes.
Want to know more about customizing your widget? See the configuration page under each widget's help topic for more information about filtering widgets by attributes and URLs.