Virtuous CRM Installation Instructions

Before you can install the Virtuous CRM subscription, you need to obtain the following credentials:

API URL
User Name
Password
Grant Type

To get the User Name, Password, and Grant Type

The integration authenticates to Virtuous CRM using a Virtuous CRM user account's User Name and Password, plus a fixed Grant Type value of password. Once entered on the iPaaS.com Subscription Settings page, the integration manages session refresh automatically — no further authentication action is required from the subscriber.

Log in to your Virtuous CRM account at https://app.virtuoussoftware.com/Account/Login.
Identify or create a Virtuous CRM user account that will be used by the integration. Record the User Name (email) and Password.
The Grant Type value is password.

NOTE: Use a dedicated service-style user account rather than a personal user account to avoid password expiration or SSO complications breaking the integration.

To get the API URL

The API URL is the same for all Virtuous CRM environments:

Test/Sandbox: https://api.virtuoussoftware.com
Production: https://api.virtuoussoftware.com

Installation Instructions for Integration Setup

Go to Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Virtuous CRM integration tile.
Click the Subscribe button.
Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.
- Format: [Product Name] - [Environment/Purpose]
- Example: Virtuous CRM – Production
Select Create Default Mappings (recommended). If you don't want to create default mappings and want to create all mappings yourself, un-check this box.
Enter the API URL, the API endpoint for your Virtuous CRM instance.
- Environment URLs:
  - Test/Sandbox: https://api.virtuoussoftware.com
  - Production: https://api.virtuoussoftware.com
Enter the User Name, the email address of the Virtuous CRM user account used for API authentication.
Enter the Password, the password for the Virtuous CRM user account used for API authentication.
Enter the Grant Type used by the integration to authenticate to Virtuous CRM. Leave this set to the default value unless directed otherwise by iPaaS.com support.
- Default Value: password
Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests.
- Default Value: 0 (Unlimited)
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured.
- Default Value: 0 (Unlimited)
Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that iPaaS.com can process for this subscription.
- Default Value: 1
Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for the Virtuous CRM integration at one time.
- Default Value: 10
- Range: 1–10
Click Apply to save the settings.

Important Notes

Hourly Request Limit: Virtuous CRM enforces a limit of 1,500 requests per hour. The integration should be configured to stay within this limit.
Credential persistence: The integration manages session refresh automatically using the credentials entered on the Subscription Settings page. You do not need to re-enter the credentials on any regular schedule. Re-enter them only if the Virtuous CRM user account is locked, has its password rotated, or has its scopes changed — at that point transfers will begin to fail with a permission error until the updated credentials are saved.

Webhook Configuration in Virtuous CRM

Virtuous CRM sends gift events to iPaaS.com using webhooks. Configure the webhook in Virtuous CRM as follows.

Log in to your Virtuous CRM account at https://app.virtuoussoftware.com/Account/Login.
On the Dashboard, click the Settings (gear) icon and select All Settings.
On the All Settings page, click Connectivity.
Select Webhooks.
Click Create a webhook.
Populate the Payload URL using the format for your environment:
- Staging: https://stagingapi.ipaas.com/hookapi/v2/dynamic/VirtuousCRM?webhookapikey={WebhookAPIKey}
- Production: https://api.ipaas.com/hookapi/v2/dynamic/VirtuousCRM?webhookapikey={WebhookAPIKey}
- The {WebhookAPIKey} value can be found on the iPaaS.com Virtuous CRM Subscription page. Click the unmask (eye) icon next to the Webhook API Key and copy the value.
NOTE: If your Webhook API Key contains a forward slash (/), the resulting payload URL will not work — Virtuous CRM cannot save or fire webhooks against URLs with embedded / characters in the API key segment, and URL-encoding the slash to %2F does not work consistently. Before pasting the URL into Virtuous CRM, check the unmasked key for a /. If one is present, contact iPaaS.com support and request a regenerated key; support will rotate the key until a slash-free one is produced and provide the corrected payload URL.
Select Let me select individual events and select Gift Create and Gift Update.
Click Save Webhook.

Post-Installation Verification

After completing the installation, perform these tests to verify the integration is working correctly.

Connection Test

Navigate to the Virtuous CRM subscription in iPaaS.com and verify the connection status shows as active.

Data Sync Test

Create a test gift in Virtuous CRM.
If the webhook configured above is in place and subscribed to Gift Create, the gift will be sent to iPaaS.com automatically — no manual sync is needed. Otherwise, trigger a manual sync from the iPaaS.com subscription.
Verify the gift appears in iPaaS.com with the correct field mappings.

Functionality Test

Update the test gift in Virtuous CRM.
If the webhook is subscribed to Gift Update, the change will propagate to iPaaS.com automatically. Otherwise, trigger a manual sync.
Verify the updated values appear in iPaaS.com.
Review integration logs in iPaaS.com for any errors.

Support and Troubleshooting

Click the Help button on any iPaaS.com page to contact Support or to search our documentation.

Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com.

Virtuous CRM-specific resources:

Documentation: https://docs.virtuoussoftware.com/#intro
Support Portal: https://support.virtuous.org/hc/en-us

Subscription Settings Reference

Field	Required	Default Value	Description
Name	Yes	—	Unique identifier for this subscription
Versions	No	v1.0.0	Integration version
Create Default Mappings	No	Checked	Auto-creates standard field mappings
API URL	Yes	—	Virtuous CRM API endpoint URL
User Name	Yes	—	Virtuous CRM user account email used for API authentication
Password	Yes	—	Virtuous CRM user account password used for API authentication
Grant Type	Yes	password	Fixed authentication type used by the integration — leave at the default
API Throttle Limit	Yes	0	Max API calls per throttle window (0 = unlimited)
API Throttle Seconds	Yes	0	Throttle time window in seconds (0 = unlimited)
Concurrent Connections	Yes	1	Max simultaneous API connections
Concurrent Batch Executions	Yes	10	Max simultaneous batch processes