home

MinistryPlatform

RealmRealm AccountingMinistryPlatformGivingPDSACSConnectShepherdGrowth MethodHeadMasterRefresh WebsitesTrust CenterGo MethodMissionInsite
RealmRealm AccountingMinistryPlatformGivingPDSACSConnectShepherdGrowth MethodHeadMasterRefresh WebsitesTrust CenterGo MethodMissionInsite

What would you like to know more about?

Show Contents

Show Page Sections

thumbnailMinistryPlatform

Extending the Platform

Power Automate

This section details everything you need to know about Microsoft's integration platform Power Automate and MinistryPlatform, including how to configure, test, and use it in the Platform.

Power Automate is Microsoft's low-to-no-code integration platform that enables workflows, automation, and more across a set of known connectors. That means you can use the power of the Platform to create automated workflows between the Platform and your favorite apps and services to synchronize files, get notifications, collect data, and more.

Note: Power Automate is a flexible, dynamic tool that takes the power of the Platform to the next level. Professional Services can help create your Power Automate Connector and initial Flow. The time Professional Services spends on Flow creation is subject to a Ready-Made Solution Consulting or Engineering fee, but once configured, you can modify the Flow as needed.
Tip: Want to see Power Automate in action? Check out the Using Power Automate to Automate Ministry webinar!

Ready to create an automation? Check out My First Power Automate Flow With MinistryPlatform In One Hour!

Configure the MinistryPlatform Connector

You should complete this multi-step process in the order displayed here, within one session of time.

First Things First

Start with these items to get everything in place before you begin:

  • Obtain your Power Automate License. You'll need a license for each person who will create a flow using the same connector. Microsoft might offer discounted pricing for non-profits.
  • Download the MinistryPlatform.swagger.json file. Feel free to review the related files in Github.
  • Open MinistryPlatform and go to the Administration section.
  • Know your MinistryPlatform base URL. Your base URL is your Platform URL without "/mp" at the end. For example, if your MinistryPlatform URL is https://example-church.ministryplatform.net/mp, your Platform base URL would be https://example-church.ministryplatform.net.
  • Open Power Automate in an Incognito browser. This way, you can sign in to the Power Automate Connector with the Power Automate User you will create instead of automatically signing in with your credentials.
  • Confirm your license gives you the access you need:
    • Click the gear icon at the top right to open the Settings menu, then select View My Licenses.
    • Most of the items under Capabilities should have a green check mark next to them.
    • Make sure that you have access to both Premium connectors and Custom connectors.

Note: Be aware that the MinistryPlatform Custom Connector does not include references to any tables that are custom to your MinistryPlatform instances. At this time, it does not include any MinistryPlatform tables that start with "dp_". You can add custom and dp tables to the Connector once configured.

In MinistryPlatform

  1. Go to Contacts, and create a new Contact record with the following information:
    1. Display Name: PowerAutomate
    2. Email: Enter an email address that will be listed as the sender when emails send from Power Automate.
  2. Go to Administration > Users and open APIUser record.
  3. Copy it (and its security roles) to a new User record. Then, enter the following information:
    1. User Name: PowerAutomate
    2. Display Name: PowerAutomate
    3. Password: P0werAutomate!
  4. Go to Administration > API Clients, and create a new API Client with the following information:
    1. Display Name: PowerAutomate
    2. Client ID: PowerAutomate
    3. Client Secret: Enter a unique secret key that will be used to authenticate the API Client.
      Tip: We recommend using the Password Generator to generate a secure value. Click the magic wand icon wand with surrounding stars beside the field to open the Password Generator and select the options you want.
    4. Client User: Select the User record you just created for Power Automate.
    5. Authentication Flow: Authorization Code, Implicit, Hybrid, Client Credentials, or resource Owner.
    6. Redirect URIs: Paste in the URL you copy from the Redirect URL field after you create the connector in Power Automate.
    7. Leave other fields as they are.

In Power Automate

  1. From the left menu, select Custom Connectors. (You may need to click More to see this option.)
  2. At the top right, click New custom connector, and select Import an OpenAPI file.
  3. Enter a Connector name, then click Import and select the MinistryPlatform.swagger.json file you downloaded.
  4. Click Continue.
  5. On the General tab, set the Host URL to your MinistryPlatform base URL. Keep the Base URL field in Power Automate as "/ministryplatformapi".
    Note: Your base URL is your Platform URL without "/mp" at the end.
  6. On the Security tab, add "PowerAutomate" to the Client ID field.
  7. For Client secret, paste in the Client Secret you generated for the API Client record in the Platform.
  8. Set the Authorization URL to {your MinistryPlatform base URL}/ministryplatformapi/oauth/connect/authorize.
    https://example-church.com/ministryplatformapi/oauth/connect/authorize.
  9. Set the Token URL and Refresh URL to {your MinistryPlatform base URL}/ministryplatformapi/oauth/connect/token.
  10. Click Create connector at the top. This populates the Redirect URL field.
    Tip: If you need to edit anything on the Security tab, scroll to the bottom and click Edit.
  11. Copy the newly created Redirect URL, and add this to the Redirect URIs field on the API Client record in the Platform.
    Note: Make sure to add a semi-colon to the end of the URL.

Test the Connector

  1. Continue through the Definition, API Plugin (preview), and Code tabs, leaving the information as it is.
  2. On the Test tab, click Update connector at the top. This may take a few minutes.
  3. Click + New Connection. You'll see a browser pop-up with the SSO window.
  4. Sign in with the username and password you created for the Power Automate User. Select the Keep me signed in check box.
  5. The Selected Connection drop-down list should display the name of the Connection and the date and time. If it does not, something is incorrect with the Connector configuration. Return to the General and Security tabs, and double-check all the values, especially the Authorization URL. To update any values, scroll down to the bottom of the Security tab and click Edit.
  6. On the Test tab, in the Tables_Get section, click Test Operation. If successful, you'll see a green check mark next to the connection you tested.
    The Operations drop-down with a green check mark next to 1 Tables_GET in blue

Using the MinistryPlatform Connector

Once you configure the Connector and start a Flow, you can use its Actions for automation. You can access these in the Custom section of the Add an action window.

If you use the cloud flows designer, it looks like this, and you can select Custom in the Runtime drop-down list:

The Add an action dialog box, with a blank search bar, Custom selected in the Runtime drop-down list, and MinistryPlatform below it

If you use the classic designer view, it looks like this:

The Choose an operation dialog box, with a blue line under the Custom tab to indicate that you're on the Custom tab, and MinistryPlatform in the area below it

Webinar
portal
MinistryPlatform

Last updated: November 26, 2024