This article guides through how to connect iDonate to Virtuous, configure settings, and manage the connection over time.
Prerequisites
Before beginning, make sure you have:
- Access to an iDonate Admin user.
- Admin access to your Virtuous account.
Connecting to Virtuous
In Virtuous
- Click Settings > All Settings > Connectivity > API Keys (not Application Keys).
- If needed, create a new API Key by clicking Create an API Key, set a Name and Permission Group, and Save.
- In the API Keys table, find the key you want to use and click the Edit button.
- Click the eye icon to display the API Key value and copy it.
API Keys serve as long-term credentials that remain active until manually revoked. Since they grant continuous access, it’s essential to keep them securely stored and avoid sharing them through email, chat, or any unsecured text files.
In iDonate
-
After obtaining your Virtuous API Key, go to iDonate and navigate to Settings > Integrations (Beta).
- Click Virtuous from within the Marketplace which will open the Virtuous Config Wizard.
- Click Configure.
- On the Virtuous Connection page input your API Key and click Next.
Configurations
The following configurations determine how data flows and behaves within your Virtuous integration. Review each setting carefully as they directly impact how information is processed and synced.
Processing
- Donor Fee Processor: Determines how donor fees are processed.
- Donor Fee Designation: The designation that will receive all donor covered fees. Required if "Donor Fee Processor" is set to "Standard". Defaults to "Standard".
Definitions
- Default Designation: When a donation occurs and does not have an associated designation, the export will use this designation when exporting to your CRM.
- Populate Receipt: Notifies Virtuous that a receipt has already been sent to a donor. Disabled by default.
- Segment Map: Determines if iDonate Campaigns or Reference Codes get mapped to Virtuous Segments. Defaults to Campaign.
Options
- Create Projects: When enabled, creates projects or designations that are not yet in Virtuous. Enabled by default.
- Label Donation Source as Beta: Optionally append Beta to the Virtuous Transaction Source for testing. When enabled, donations are sent to a separate batch, keeping test data distinct from live iDonate records. Disabled by default.
- Group Donations by Currency: Optionally append currency code to the Virtuous Transaction Source, resulting in separate batches for each currency (e.g. USD vs. CAD). Disabled by default.
After reconfiguring any settings in the Config Wizard, be sure to click Finish on the final step. Changes are only saved once you complete the wizard by selecting Finish.
Disconnecting the Integration
- Navigate to the Integration Marketplace page and click on Virtuous.
- Click the ellipsis menu (...) next to Reconfigure and click Deactivate Integration.
Deactivating the integration will completely stop data from syncing to Virtuous. Before you deactivate, consider pausing the instance instead. This temporarily stops syncing without removing your existing settings. If you deactivate, all previous configuration settings will be lost.
Object Mapping
| iDonate Object | Virtuous Object |
| Designations | Projects |
| Campaigns* | Segments |
| Donations | Gifts |
| Donors | Contacts |
*Integration configuration also allows for Reference Code to map to Segment.
Troubleshooting
If you run into issues with your integration:- Check the Logs tab on the Integrations (beta) page for specific errors.
- Double check your Virtuous API Key is correct and active.
- Contact iDonate support with log details and/or any other relevant information.