Skip to main content

Virtuous CRM Connections and Settings

Virtuous CRM Connections and Settings

Integrate iPaaS.com with Virtuous CRM to enable seamless data synchronization for Virtuous CRM Gift records flowing into iPaaS.com as Transactions.

This document is the ongoing reference for the Virtuous CRM subscription — what each setting on the iPaaS.com Subscription page does, where its value comes from, how authentication works, and how to keep the connection healthy after installation. For the first-time setup walkthrough (marketplace subscription, post-install verification, webhook configuration in Virtuous CRM), see the Virtuous CRM Installation Instructions article instead.

Prerequisites

Before configuring the iPaaS.com subscription, you need the following from the Virtuous CRM side:

  • A Virtuous CRM user account that the integration will authenticate as. Use a dedicated service-style user account rather than a personal user account to avoid password expiration or SSO complications breaking the integration. Record the user's email (used as User Name) and the password.

  • The Virtuous CRM API URL (https://api.virtuoussoftware.com). Virtuous CRM hosts a single API endpoint for all tenants — there is no separate sandbox URL.

  • Access to the Virtuous CRM admin UI so you can configure the webhook subscription (Settings → Connectivity → Webhooks) once the iPaaS.com subscription is in place. See the Virtuous CRM Installation Instructions article for the webhook walkthrough.

For details on Virtuous CRM authentication and tokens, see the Virtuous CRM API documentation index.

Configuration Details

Have the following values ready before opening the iPaaS.com Subscription Settings page:

  • API URL: the Virtuous CRM API endpoint. Use https://api.virtuoussoftware.com for all environments.

  • User Name: the email address of the Virtuous CRM user account the integration will authenticate as. Example: integration.user@example.org.

  • Password: the password for that Virtuous CRM user account.

  • Grant Type: the authentication type used by the integration. Always set to password (the integration's only supported authentication mode).

Configure Subscription Settings

The iPaaS.com Subscription Settings page for Virtuous CRM exposes the connection credentials, throttle limits, and concurrency caps for the integration. Open Subscriptions → Virtuous CRM in the iPaaS.com portal to access it.

Virtuous CRM Subscription Settings page in iPaaS.com

Field

Description

Required

Example

Name

Unique identifier for this subscription. Set this to any name that distinguishes the subscription from other integrations on the same iPaaS.com tenant.

Yes

Virtuous CRM - Production

Versions

The integration version. Pre-populated with the latest available release.

No

v1.0.0

Create Default Mappings

When checked, iPaaS.com auto-generates the default template mappings for the Add/Update Virtuous CRM Gift TO iPaaS.com collection on first install. Uncheck only if you intend to build all mappings from scratch.

No

Checked

API URL

The Virtuous CRM API endpoint. Same URL for staging and production environments.

Yes

User Name

The email address of the Virtuous CRM user account used for API authentication.

Yes

Password

The password for the Virtuous CRM user account used for API authentication.

Yes

(masked)

Grant Type

The authentication type used by the integration. Leave at the default value.

Yes

password

API Throttle Limit

Maximum API calls per throttle window. 0 means unlimited (the default). Virtuous CRM enforces its own hourly cap of 1,500 requests/hour regardless of this setting.

Yes

0

API Throttle Seconds

Throttle time window in seconds. 0 means unlimited (the default).

Yes

0

Concurrent Connections

Maximum number of simultaneous API connections iPaaS.com will open against Virtuous CRM for this subscription.

Yes

1

Concurrent Batch Executions

Maximum number of simultaneous batch executions for the integration. The integration does not currently run batches but the setting is exposed.

Yes

10

Authentication Methods

The integration authenticates to Virtuous CRM using the credentials stored on the iPaaS.com Subscription Settings page. The authentication exchange runs automatically — there is no separate OAuth consent flow for the subscriber to step through.

  1. Confirm or update the User Name, Password, API URL, and Grant Type on the iPaaS.com Subscription Settings page.

  2. Save the subscription. iPaaS.com exchanges the credentials with Virtuous CRM at [API URL]/Token to obtain a session.

  3. iPaaS.com manages session refresh automatically for the lifetime of the subscription. No further authentication action is required from the subscriber unless the underlying Virtuous CRM user account is locked, has its password rotated, or has its scopes changed — at which point the integration will start to fail with a permission error (see the Virtuous CRM Error Messages article for the exact message).

To rotate credentials (for example, after a scheduled password change on the Virtuous CRM user account), return to the iPaaS.com Subscription Settings page, update the Password field with the new value, and save. The next authentication exchange will use the updated credentials and the integration resumes automatically.

If you need to switch the integration to a different Virtuous CRM user account, update both User Name and Password on the Subscription Settings page in the same edit.

Initialization Support

Currently, initialization is not supported for Virtuous CRM in iPaaS.com. The integration does not provide a bulk back-fill or "initial sync" mode for pre-existing Virtuous CRM gifts. Only gifts received through the Gift Create / Gift Update webhook stream (or pulled individually via the iPaaS.com Manual Sync page using a specific gift id) reach iPaaS.com after install.

If you need historical gifts in iPaaS.com, plan a manual back-fill using the Manual Sync page (one gift id at a time) or with a bulk sync using Postman. See the Virtuous CRM Integration Known Limitations article for more on the historical-sync constraint.

Throttling

The API Throttle Limit, API Throttle Seconds, Concurrent Connections, and Concurrent Batch Executions fields on the Subscription Settings page control how aggressively iPaaS.com calls the Virtuous CRM API. These fields are pre-populated with sensible defaults for the integration's current scope and do not normally need to be changed.

Virtuous CRM enforces its own rate limit of 1,500 requests per hour per API token, independent of the iPaaS.com throttle settings. When iPaaS.com hits that Virtuous CRM-side limit during a burst of activity, the affected transfers are automatically rescheduled to resume after the limit resets — no subscriber action is required and no work is lost. See the Virtuous CRM Integration Known Limitations article for the operational implications.

For background on how iPaaS.com applies the throttle and concurrency settings in general, see the Subscription Configuration – Edit article in the iPaaS.com help center.

Related Documents

External References

Did this answer your question?