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 and later 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. The plugin fills it in when you validate your API client.
Org Key: Your Subsplash organization's identifier. The plugin fills it in when you validate your API client, so you don't need to enter it.
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.
Client Id
Client Secret
Auth Provider ID (only if you use SSO)
Share your Rock information with Subsplash
Once you have the Rock plugin added to your subscription, you'll receive your secure 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 is automatically created for you to leverage syncing for Giving, Groups, and People profile data.
Check the Subsplash Sync job
To ensure Subsplash Sync is enabled after install, navigate to Admin Tools > Settings > Jobs Administration > Subsplash Sync.
The Subsplash Sync job is active by default and runs every 15 minutes, which we recommend. Each time it runs, it checks your API client settings and runs only the syncs that are turned on at that interval.
If you used the individual Subsplash Giving or Groups sync jobs, the upgrade turns them off and adds [Legacy] to their names. You can leave them inactive.
Add your API client
To ensure syncing works as expected, configure your API client by taking the following steps:
Navigate to Admin Tools > Installed Plugins > Subsplash > Settings.
Click + to add a new API client. If an API client already exists, click it to open it instead.
Enter a name for your API client. You can use any name.
Enter the Client ID and Client Secret from the Subsplash section of your secured doc.
Click Validate to connect to Subsplash. The plugin fills in your App Key and Org Key.
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. It is off by default.
Frequency: Sets how often the job syncs People data.
People Sync Settings: Sets which direction profiles sync: Subsplash to Rock, Rock to Subsplash, or both.
Groups
Use the Groups settings to control how Rock groups and their members sync with Subsplash Groups & Messaging. These settings require Rock Plugin version 3.1.0 or later. To finish setting up Groups, including automatic group creation, see our 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.
Group Type mapping: Connects a Rock group type to a Subsplash group type. The plugin then creates a Subsplash group for each eligible Rock group of that type.
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
You don't need to enter a Webhook Secret. When you save your API client, the plugin connects to Subsplash and sets up the webhook and its secret for you. To finish setting up push notifications, see our 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.