Skip to main content

Virtuous CRM

Updated

Connect Virtuous CRM to Avid with an application programming interface (API) key. Avid then syncs your Virtuous CRM data.

Use this article when

  • You connect Virtuous CRM to Avid for the first time.
  • You replace the API key for an existing connection.
  • You use Virtuous Raise and send its gifts to Virtuous CRM.

Overview

Virtuous CRM is a customer relationship management (CRM) system. Avid reads these data types:

  • Contacts
  • Gifts
  • Campaigns
  • Communications
  • Segments
  • Projects
  • Recurring gifts

To request a fresh sync after setup, use Sync Now in Avid.

Applies to and prerequisites

Requirement Details
CRM Virtuous CRM
Role Virtuous CRM user with access to Settings and API-key management
Avid access Edit access to Connections & Files
Credentials API Key

The API key is a secret connection credential. Store it securely. Do not send it in a support request.

Create the Virtuous API key

If your team already has a Virtuous API key, continue to Add Virtuous CRM to Avid.

  1. In Virtuous, open Settings, then All Settings.
  2. Open CONNECTIVITY, then API Keys.
  3. Select CREATE AN API KEY.
  4. Enter a descriptive name.
  5. Leave Permission Group set to Admin (or create/use a permission group with Read access for the objects listed above), then select Save.
  6. Edit the new key and use the copy control to copy it.
  7. Store the key securely.

Add Virtuous CRM to Avid

  1. In Avid, go to Settings > Connections.
  2. Select Add System.
  3. Use Search by Name... to find and select Virtuous CRM.
  4. Paste the key into API Key.
  5. Select Save.
  6. Confirm the connection reaches Active. It may show Initializing or Syncing first.

Verify the connection

  1. Open Settings > Connections.
  2. Confirm the Virtuous CRM connection shows Active.
  3. Select View Connection.
  4. Confirm the expected Virtuous CRM data appears.
  5. To request a fresh sync, open Actions and select Sync Now.

Replace the API key

  1. Create and copy a replacement key in Virtuous.
  2. In Avid, open Settings > Connections.
  3. Open Actions for the Virtuous CRM connection.
  4. Select Update Credentials.
  5. Paste the replacement key into API Key.
  6. Select Save.
  7. Confirm the connection returns to Active.

If you use Virtuous Raise

Use Virtuous CRM when Raise sends your gifts to Virtuous CRM.

See Get Virtuous Raise donation data into Avid for other methods and limitations.

Troubleshooting

Virtuous CRM rejects the API key

Avid displays The API Key entered was not able to successfully connect to a Virtuous CRM instance. Please check your entry and try again.

Create a replacement API key with Permission Group set to Admin. Copy the new key and try again.

The connection is active, but records are missing

Confirm the records exist in Virtuous CRM. Then select View Connection and check the expected data type.

Open Actions, select Sync Now, and check again after the sync completes.

Known limitations

  • Avid needs a Virtuous CRM API key to establish this connection.
  • This connection does not connect directly to the current Virtuous Raise product.

When to contact LockStep Support

Contact LockStep Support if the connection remains in Retrying or Error.

You can also contact Support if expected records remain missing after a sync.

Include:

  • The connection name and current status.
  • The full error text. Do not include the API key.
  • A screenshot of Settings > Connections without donor data or credentials.
  • The date and time of the last attempted sync.
  • The expected record type.

Related articles