This process starts by generating some key information to send to Subsplash. We will then complete our part in establishing your API credentials and setting up SSO/authentication (if applicable) and share these details back to you to complete the configuration of your plugin within Rock.
Prerequisites
Rock RMS Version 16.1 or higher
This version is necessary for the addition of OpenID Connect (OIDC).
Subsplash Package/Add-on
Use of the Rock Plugin in Subsplash requires a specific package and add-on. The plugin is free in the Rock shop to download but you will not be able to start set up until sign up/upgrade.
Since setup of the plugin involves both you and Subsplash, 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.
Key Terms
Subsplash App Key/Org Key
These are unique identifiers of your account in Subsplash. Your app key is available in your Subsplash Dashboard displayed near the bottom of the home page. Your org key will be provided to you by Subsplash when we complete our half of set up.
Secured Doc
We will share a private doc with you to coordinate and share the information needed to set up the plugin.
Rock OIDC Credentials
You will generate a Client Id and a Client Secret in Rock to send to Subsplash.
Base URL
Your Rock external site domain/subdomain, either default or custom. If unsure, the default is “my.domain.com” and this is a great place to start. This will be the foundation site that SSO uses in app for authentication.
Subsplash Auth Info
Shared via the secure doc during the setup process.
This Client Id and Client Secret are different from the ones you generate in Rock.
Push Notification Endpoint
Token Endpoint
App Key (should match the one you sent)
Org Key
Client Id
Client Secret
Auth Provider ID
Public Payment Key
Webhook Secret
Share your Rock information with Subsplash
At this point you should have your secured doc from us and will need to provide the following information for us to configure the plugin on our side:
Rock Client Id/Secret - created following these steps.
Base URL - your domain used for your external site(s).
Profile Page URL - only required if using SSO and created during its setup process.
Profile Header URL - only required if using SSO and created during its setup process.
Once your part of the doc is complete just let us know and we will complete our part and pass the below information back to you.
Configure your Subsplash Plugin
At this point, you should have the following from us provided in your secure document:
Push Notification Endpoint
Token Endpoint
App Key (should match the one you sent)
Org Key
Client Id
Client Secret
Auth Provider ID
Public Payment Key
Webhook Secret
If anything is missing, please reach out to us again.
Go to Admin Tools > Installed Plugins > Subsplash > Settings and add a new API client with the + button.
Environment will always be Production
Once you have completed all settings, click Save.
At this point, you have completed the minimum requirements to use the plugin and go into setup for specific parts of the plugin to take advantage of the full feature set like Push Notifications, Donation Sync, etc. What you use is determined by your Subsplash subscription (i.e. Group sync will show as an option in the plugin but will not work if you do not have access to Groups & Messaging in Subsplash). The rest of this collection of articles will walk through those feature and setup related to them.