> ## 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.

# Setup Requirements

> Prerequisites and information needed to set up the WeGive DonorDirect integration

# DonorDirect Integration Setup Requirements

Before configuring the WeGive DonorDirect integration, your organization and
WeGive's team need to complete some prerequisite access and configuration
steps together. Because StudioEnterprise's data-sync API is account-scoped
rather than built for bulk export, WeGive builds and hosts a small set of
custom, read-only data endpoints directly against your StudioEnterprise
database in partnership with your team — this section explains what that
means for setup.

<Warning>
  Setup for DonorDirect is more involved than WeGive's other CRM integrations
  because of this custom-endpoint step. Plan for a coordinated setup process
  with your DonorDirect administrator and WeGive's implementation team, rather
  than a fully self-serve connection.
</Warning>

## Prerequisites

### StudioEnterprise Requirements

<AccordionGroup>
  <Accordion title="Administrative Access">
    * A StudioEnterprise account with System Administration module access
    * Permission to manage API Endpoints and security roles (SAWs)
    * A dedicated service account for scheduled sync is strongly recommended,
      rather than running sync under a personal login
  </Accordion>

  <Accordion title="Database Access">
    * Read/write (`db_owner`) access to your StudioEnterprise business database,
      so WeGive's implementation team can author the custom data-sync stored
      procedures your integration will use
    * This access is typically granted through your DonorDirect environment's
      standard VPN/database access process — check with your DonorDirect
      account team about what's required on your side
  </Accordion>

  <Accordion title="Data Structure">
    * An understanding of how your organization uses Projects (funds), Source
      Codes (campaigns), and recurring giving in StudioEnterprise
    * Any custom account attributes or codes you rely on, so they can be
      reviewed for inclusion in the sync
  </Accordion>
</AccordionGroup>

### WeGive Requirements

<AccordionGroup>
  <Accordion title="Account Access">
    * WeGive organization account with admin privileges
    * Access to the WeGive Dashboard integration settings
    * Understanding of your WeGive fund and campaign structure
  </Accordion>
</AccordionGroup>

## Setup Process

Because DonorDirect's sync relies on custom data endpoints built specifically
for your environment, initial setup is a joint process between your
organization and WeGive:

<Steps>
  <Step title="Access provisioning">
    Your DonorDirect administrator grants WeGive's implementation team database
    access to a non-production (test) environment first.
  </Step>

  <Step title="Custom endpoint setup">
    WeGive's team builds and deploys the read-only data endpoints needed for
    sync, scoped to accounts, gifts, recurring plans, funds, and campaigns.
  </Step>

  <Step title="Test environment validation">
    The integration is validated against your test environment before any
    production connection is made.
  </Step>

  <Step title="Production access and go-live">
    Once validated, the same process is repeated against your production
    environment, and sync is enabled.
  </Step>
</Steps>

## Required Information

### From StudioEnterprise

| Requirement | Description |
| - | - |
| **Environment host** | Your StudioEnterprise environment (production and test/sandbox, if available) |
| **API credentials** | A service-account login for scheduled sync, separate from any individual's personal login |
| **Default Project** | A Project (fund) to use for gifts pushed from WeGive without a specific designation |
| **Default Source Code** | A Source Code (campaign) to use for gifts pushed from WeGive without a specific campaign |
| **Recurring giving category** | How your organization categorizes recurring/sustaining gifts in StudioEnterprise |

### From WeGive

* WeGive organization ID
* Understanding of your existing WeGive fund and campaign structure, for
  mapping against StudioEnterprise Projects and Source Codes

## Synchronization Preferences

Determine which data types and directions you want enabled. Pull (import
from StudioEnterprise into WeGive) and push (send WeGive activity to
StudioEnterprise) are configured independently per data type:

<CardGroup cols={2}>
  <Card title="Accounts">
    Import donor and household records from StudioEnterprise
  </Card>

  <Card title="Transactions">
    Sync one-time gifts in both directions
  </Card>

  <Card title="Recurring Plans" icon="repeat">
    Sync sustaining/recurring giving schedules
  </Card>

  <Card title="Funds & Campaigns">
    Import Projects and Source Codes as WeGive funds and campaigns
  </Card>
</CardGroup>

<Note>
  **Push is off by default for every data type.** Your organization enables
  each push direction explicitly — enabling pull alone will never write data
  back to StudioEnterprise. See [Configuration
  Options](/external/onboarding/donordirect/configuration-options) for the
  full toggle list.
</Note>

## Data Quality Considerations

<AccordionGroup>
  <Accordion title="Contact Information">
    * StudioEnterprise requires a defined "type" on every stored email, phone,
      and address (for example, "Home" or "Business") — WeGive maps its fixed
      contact-info fields to whichever type codes your organization configures
    * A contact field with no matching type configured is not sent
  </Accordion>

  <Accordion title="Gift Status">
    * StudioEnterprise's transaction status semantics are still being finalized
      as part of this integration's rollout — this section will be updated with
      concrete guidance once that mapping is confirmed
  </Accordion>
</AccordionGroup>

## Next Steps

Once prerequisites and access are confirmed:

<CardGroup cols={2}>
  <Card title="Configuration Options" href="/external/onboarding/donordirect/configuration-options">
    Learn how to configure sync settings in WeGive
  </Card>

  <Card title="Data Mapping" href="/external/onboarding/donordirect/data-mapping/overview">
    Understand how data is mapped between systems
  </Card>
</CardGroup>

## Support

Need help with setup or access provisioning? Contact our support team at
[support@wegive.com](mailto:support@wegive.com).


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