> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wegive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration Options

> Configuration settings for the WeGive Virtuous integration

# Configuration Options

## Authentication Settings

| Setting | Type | Required | Description |
| - | - | - | - |
| **API Key** | String | Yes | Your Virtuous API key, generated from Virtuous Settings → API Keys. Encrypted at rest. |
| **Enabled** | Boolean | Yes | Master toggle for the integration |
| **Default Communication ID** | String | Yes | Required before any campaign can push — pushing a campaign without this set fails outright |

<Warning>
  **There's no per-object Push/Pull toggle that actually works.** Every object type this integration supports (donors, transactions, funds, campaigns, scheduled donations, contact individuals) pushes and pulls unconditionally once the integration is enabled — there's no dashboard setting that turns off sync for one object type while leaving others on.
</Warning>

## What's Actually Configurable

| Setting | Type | Description |
| - | - | - |
| **Real Time** | Boolean | Enables webhook-driven real-time push in addition to the daily batch job |
| **Pull Frequency** | Integer (minutes) | How often the pull runs; unset uses the platform default schedule |
| **Pull By** | Field | Which Virtuous timestamp field to use for incremental pulls (default: Last Modified Date) |
| **Pull Contact Individuals** | Boolean | Also pulls individual-level records under each Contact |
| **Household Contact Types** | List | Which Virtuous `contactType` values import as WeGive households (defaults to Household/Staff/NATL) |
| **Phone/Email/Address Type Mappings** | Maps | Which WeGive phone/email/address field routes to which Virtuous contact-method type on push and pull |
| **Batch Contact Matching Mode** | Enum | How batch-submitted gifts get matched to a Virtuous contact |
| **Batch Gift Update Mode** | Enum | Whether/how a batch-imported gift gets updated after the org approves it |
| **Sync Not-Public Funds** / **Not-Public Fund Mode** | Boolean / Enum | Whether funds not marked publicly visible still sync, and how |
| **Archive Funds When Inactive / Not Public / Not Available Online** | Boolean | Auto-archival rules for funds that go inactive on either side |
| **Send Processing ACH as Success** | Boolean | Whether an in-flight ACH transaction reports as a success to Virtuous |
| **Create Logins for All Company Contacts** | Boolean | Whether every contact under a company gets a WeGive login, not just the primary |
| **Enable Reversing Transactions** | Boolean | Whether a WeGive refund creates a reversing gift in Virtuous rather than just updating status |

## Contact Configuration

Household grouping, primary-individual designation, and Contact ↔ ContactIndividual relationship handling are automatic — driven by the `household_contact_types` setting and Virtuous's own contact hierarchy, not separately configurable business rules.

## Duplicate Prevention

Contact/gift/fund/campaign creation is protected by a Redis lock per record, not by email or name matching — a record already linked by its Virtuous ID is never re-created.

## Getting Help

* **WeGive Support**: [support@wegive.com](mailto:support@wegive.com)
* **Virtuous API Documentation**: [developers.virtuoussoftware.com](https://developers.virtuoussoftware.com/)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.