Prerequisites
Package/Add-on
Use of the Ministry Platform integration in Subsplash requires a specific package and add-on.
Contact Subsplash
Setup involves both you and Subsplash so make sure to contact your Client Success Manager (CSM) if you have not been talking with them. If you are not currently a Subsplash client, please connect with us.
Create an API Client in Ministry Platform
To ensure secure and trackable integration, we recommend creating a dedicated API Client and API User for your Subsplash integration. This allows you to precisely control permissions and easily monitor activity in the Audit Log.
Create a New Company Contact for the API User (Subsplash)
Navigate to Contacts > Add/Edit Company tool.
Add a new Company Contact "Subsplash" that will represent your Subsplash API User in the next step.
Create a New User for the Company Contact
Create a new user account in Ministry Platform, associating it with the Company Contact you just created.
Ensure this new user has a security role with Administrator rights. This is crucial for the API client to function correctly.
Add a New API Client Record
Go to the API Clients Page.
Add a new API Client record.
Name the API Client - Give it the name "Subsplash". This name will appear in the Audit Log, making it easy to identify actions taken by the Subsplash integration.
This should set the Client Id to the same name, if not then use "Subsplash".
Set the Client User to the user created in the previous steps.
For the Client Secret, click Generate a new secret key
Set the Redirect URL to:
https://core.subsplash.com/end-user-auth/v1/authproviders/resultSet Authentication Flow(s) to Authorization Code, Implicit, Hybrid, Client Credentials, or Resource Owner.
Provide Credentials to Subsplash
Once your API Client is set up and permissions are configured, you will need to securely provide the following credentials to Subsplash via the secure set up doc:
Ministry Platform Instance URL: Your unique Ministry Platform URL
Client ID: This is a unique identifier for your API Client (e.g., "Subsplash").
Client Secret: This is a confidential key used to authenticate your API Client.
If you do not have your secure set up doc, be sure to connect with your Client Success Manager or Ministry Consultant after upgrading or signing up.