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
App Key — Can be found on the homepage of your Subsplash Dashboard in bold black lettering.
Org Key — Will be provided to you by Subsplash in your secured doc.
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 from Subsplash.
Push Notification Endpoint
Token Endpoint
Client Id
Client Secret
Auth Provider ID
Webhook Secret
Share your Rock information with Subsplash
Once you have the Rock plugin added to your subscription, you'll receive your secured doc from Subsplash and will need to provide the following information for us to configure credentials to complete your Rock plugin setup:
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, reach out to support and we will configure the required credentials and pass the below information back to you.
Configure your Subsplash Plugin
At this point, you should have all that's needed from us provided in your secure document. 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.
API Client Details
When prompted, enter a name for your API client along with the Client ID and Client Secret. You may choose any name you like, the ID and secret are located in your secure document under the Subsplash section.
Once you've entered the name, ID, and secret, click Validate to establish a successful connection to Subsplash.
Groups
There are two primary settings you can configure for groups. To complete setup for Groups, see our help article here.
Group Member Sync Settings — Used to control how group members are controlled and synced between Subsplash and Rock.
Suppress Notifications — Prevents email notifications from being sent to the group member when they're added to a Subsplash group.
Finance
Under the Finance dropdown, you can configure settings if you intend to sync Subsplash giving data to Rock. To complete setting up Giving syncing to Rock, see our help article here.
Donor Covered Fees Account — By default, donor covered fees will be associated with the same account as the original gift. If you would like to move them into their own account, you can adjust the plugin setting to a specific Rock account.
Batch Method — Determines how your giving transactions will be batched in Rock. To learn more about each option, see our help article here.
Push Notifications
To allow push notifications between Rock and Subsplash, add the Webhook Secret from the provided secured doc. To complete setup for Push Notifications in Rock, see our help article here.
Auth/SSO
If using Auth/SSO, enter the Auth Provider ID provided to you in your secured doc. To complete setup of SSO, see our help article here.
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.