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
Plugin version 3.0.0 requires Rock RMS version 17 through 19
This version is necessary for the addition of OpenID Connect (OIDC).
Subsplash API Access
Use of the Rock Plugin in Subsplash requires access to the Subsplash API. The plugin is free in the Rock shop to download, but you will not be able to start setting up until you upgrade your package.
If you'd like to discuss API eligibility, options, or pricing, connect with your Subsplash Client Success Manager!
Note: Plugin version 3.0.0 no longer supports Rock version 16.
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 the 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 information below back to you.
Configure your Subsplash Plugin
New to plugin version 3.0.0 is Subsplash Sync. A single job automatically created for you to leverage syncing for Giving, Groups, and People profile data.
Subsplash Sync
To ensure Subsplash Sync is enabled after install, navigate to Admin Tools > Settings > Jobs Administration > Subsplash Sync.
These settings are enabled by default and checks for settings in your API client for syncing. Ensure the Active checkbox is selected, update any settings to your organization's preference and click Save.
If you have an individual job syncing Subsplash Giving or Groups, once you've confirmed Subsplash Sync is enabled and the API client settings are configured, you can disable the individual jobs.
API Client Details
Go to Admin Tools > Installed Plugins > Subsplash > Settings and add a new API client with the + button.
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.
People
The People settings allow you to configure keeping People profile data in sync between Subsplash and Rock. To learn more about the People sync, see our guide here.
Sync: When enabled, it will be included in the Subsplash Sync job at the frequency selected.
Frequency: Determines how often People data will be included as a part of the Subsplash Sync job.
People Sync Settings: Select if you want profile syncing to be bi-directional between both platforms.
Groups
There are two primary settings you can configure for groups. To complete the setup for Groups, see our help article here.
Sync: When enabled, it will be included in the Subsplash Sync job at the frequency selected.
Frequency: Determines how often Group data will be included as a part of the Subsplash Sync job.
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.
Donations & Payments
Under the Donations & Payments dropdown, you can configure settings if you intend to sync Subsplash transaction data to Rock. To complete setting up Giving syncing to Rock, see our help article here.
Sync: When enabled, it will be included in the Subsplash Sync job at the frequency selected.
Frequency: Determines how often transaction data will be included as a part of the Subsplash Sync job.
Donation Sync Days Back: The amount of days that will be included in the sync. We recommend 14 days to capture any ACH transactions that need to capture and assigned to their appropriate batch.
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 the 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 the setup of SSO, see our help article here.
Once you have completed all settings, click Save.