Neon CRM Configuration Options
Detailed configuration options and settings for the WeGive Neon CRM integration
Configuration Options
The WeGive Neon CRM integration offers comprehensive configuration options to customize synchronization behavior, data mapping, and integration features according to your organization’s specific needs.
Integration Settings
Basic Configuration
Authentication Settings
- Neon Organization ID: Your unique Neon CRM organization identifier
- Neon API Key: Secure API key for authentication with Neon CRM
- Environment: Production (
api.neoncrm.com
) or Staging (trial.neoncrm.com
)
Integration Status
- Enabled: Master switch to enable/disable the entire integration
- CRM Sync: Controls whether data synchronization is active
- Two-way Sync: Enables bidirectional data synchronization
Synchronization Control
Entity Tracking Options
- Track Donations: Synchronize donation/transaction data
- Track Donors: Synchronize donor/account information
- Track Recurring Donations: Synchronize scheduled donation data
- Track Campaigns: Synchronize campaign and fundraising data
Sync Direction Options
Each entity type can be configured for:
- Push Only: WeGive → Neon CRM synchronization
- Pull Only: Neon CRM → WeGive synchronization
- Bidirectional: Full two-way synchronization
- Disabled: No synchronization for specific entity types
Webhook Configuration
Real-time Sync Events
When two-way sync is enabled, webhooks are automatically configured for:
Account Events
- CREATE_ACCOUNT: New donor account creation in Neon CRM
- UPDATE_ACCOUNT: Donor account modifications in Neon CRM
Donation Events
- CREATE_DONATION: New donation creation in Neon CRM
- UPDATE_DONATION: Donation modifications in Neon CRM
Webhook Settings
- Content Type:
application/json
- Authentication: API token-based authentication
- Retry Logic: Automatic retry on webhook delivery failures
- Error Handling: Comprehensive error logging and notification
Data Mapping Configuration
Default Field Mappings
The integration includes pre-configured mappings for common fields:
Donor/Account Mappings
WeGive Field | Neon Field | Direction | Required |
---|---|---|---|
first_name | primaryContact.firstName | Bidirectional | Yes |
last_name | primaryContact.lastName | Bidirectional | Yes |
email_1 | primaryContact.email1 | Bidirectional | Yes |
email_2 | primaryContact.email2 | Bidirectional | No |
email_3 | primaryContact.email3 | Bidirectional | No |
email_notifications | consent.email | Bidirectional | No |
sms_notifications | consent.sms | Bidirectional | No |
Donation/Transaction Mappings
WeGive Field | Neon Field | Direction | Required |
---|---|---|---|
amount | amount | Bidirectional | Yes |
created_at | date | Bidirectional | Yes |
donor_name | donorName | Bidirectional | Yes |
anonymous | anonymousType | Bidirectional | No |
fee_amount | donorCoveredFee | Bidirectional | No |
tribute_name | tribute.name | Bidirectional | No |
payout.paid_at | receivedDate | Export Only | No |
Campaign Mappings
WeGive Field | Neon Field | Direction | Required |
---|---|---|---|
name | name | Bidirectional | Yes |
goal | goal | Bidirectional | No |
start_date | startDate | Bidirectional | No |
expiration | endDate | Bidirectional | No |
total_donated | statistics.donationAmount | Import Only | No |
number_of_donations | statistics.donationCount | Import Only | No |
Custom Field Mapping
JSONPath Support
The integration supports JSONPath expressions for complex field mapping:
Mapping Levels
- Import: Only used when importing data from Neon CRM
- Export: Only used when exporting data to Neon CRM
- Bidirectional: Used for both import and export operations
Custom Field Types
- Standard Fields: Built-in fields in both platforms
- Custom Fields: Organization-specific fields requiring mapping
- Computed Fields: Fields calculated during synchronization
- Literal Values: Static values assigned during sync
Payment Method Configuration
Tender Type Mapping
Configure how WeGive payment methods map to Neon tender types:
WeGive Source Type | Neon Tender Type | Description |
---|---|---|
card | Credit Card Offline | Credit/debit card payments |
bank | Check | Bank transfers and ACH payments |
donor | Check | Donor-funded payment methods |
Card Type Mapping
Credit card issuer mapping for detailed payment tracking:
WeGive Card Type | Neon Card Code | Description |
---|---|---|
visa | V | Visa cards |
mastercard | M | MasterCard |
amex | A | American Express |
discover | D | Discover cards |
Address Management
Address Types
- Primary Address: Main address marked as primary in Neon CRM
- Mailing Address: Dedicated mailing address
- Billing Address: Billing address for payment processing
Address Synchronization
- Automatic Creation: Addresses created automatically with donor accounts
- Update Logic: Existing addresses updated based on primary designation
- Phone Integration: Phone numbers included with address records
Error Handling and Logging
Integration Logging
- Activity Tracking: Complete audit trail of all integration activities
- Error Logging: Detailed error messages and resolution guidance
- Performance Monitoring: API usage and response time tracking
- Webhook Monitoring: Webhook delivery status and error tracking
Error Recovery
- Automatic Retry: Failed operations automatically retried
- Manual Retry: Administrative interface for manual retry of failed operations
- Error Notifications: Configurable notifications for integration errors
- Data Validation: Pre-sync validation to prevent common errors
Advanced Configuration
Rate Limiting
- API Throttling: Built-in rate limiting to respect Neon CRM API limits
- Batch Processing: Efficient batch operations for large data sets
- Queue Management: Intelligent queuing of sync operations
- Performance Optimization: Automatic optimization based on usage patterns
Environment-Specific Settings
Production Configuration
- API Endpoint:
https://api.neoncrm.com/v2/
- Webhook Base:
https://super.givelist.app/api/
- Full Features: All integration features enabled
- Production Monitoring: Enhanced monitoring and alerting
Staging/Development Configuration
- API Endpoint:
https://trial.neoncrm.com/v2/
- Webhook Base:
https://api.staging.givelist.app/api/
- Testing Features: Safe testing environment
- Development Tools: Additional debugging and testing capabilities
Integration Security
Data Protection
- Encryption: All data transmission encrypted via HTTPS
- API Key Security: Secure storage and handling of API credentials
- Access Controls: Role-based access to integration settings
- Audit Logging: Comprehensive logging of all integration activities
Compliance Features
- Data Privacy: GDPR and privacy compliance features
- Consent Management: Proper handling of communication consent
- Data Retention: Configurable data retention policies
- Export Controls: Data export and portability features
Configuration Best Practices
Initial Setup
- Start with Core Fields: Begin with essential field mappings
- Test Thoroughly: Validate all mappings in staging environment
- Gradual Rollout: Enable features incrementally
- Monitor Performance: Watch for sync performance and errors
Ongoing Management
- Regular Review: Periodically review and update field mappings
- Performance Monitoring: Monitor API usage and sync performance
- Error Management: Promptly address and resolve sync errors
- Staff Training: Keep team updated on configuration changes
Data Quality
- Clean Data: Ensure data quality before enabling sync
- Consistent Formatting: Maintain consistent data formats
- Regular Validation: Periodic validation of synchronized data
- Backup Strategy: Regular backups before configuration changes
Configuration API
Programmatic Configuration
The integration supports API-based configuration for:
- Field Mapping Management: Create, update, and delete field mappings
- Integration Settings: Modify integration parameters
- Webhook Management: Configure webhook endpoints and settings
- Monitoring Access: Retrieve integration logs and statistics
Configuration Endpoints
GET /neon-integrations/{id}
: Retrieve integration configurationPUT /neon-integrations/{id}
: Update integration settingsGET /neon-mapping-rules
: List field mapping rulesPOST /neon-mapping-rules
: Create new field mapping rulesPUT /neon-mapping-rules/{id}
: Update existing field mapping rulesDELETE /neon-mapping-rules/{id}
: Remove field mapping rules
Troubleshooting Configuration
Common Issues
- Authentication Errors: Verify API credentials and permissions
- Mapping Conflicts: Resolve conflicting field mappings
- Webhook Failures: Check webhook endpoint accessibility
- Data Type Mismatches: Ensure compatible data types between platforms
Diagnostic Tools
- Configuration Validator: Built-in validation of configuration settings
- Mapping Tester: Test field mappings before activation
- Connection Tester: Verify API connectivity and authentication
- Sync Simulator: Preview sync operations before execution
Support and Resources
Configuration Help
- Documentation: Comprehensive configuration guides
- Examples: Real-world configuration examples
- Best Practices: Industry best practices and recommendations
- Training: Configuration training and workshops
Technical Support
- Integration Support: Specialized technical support for configuration issues
- Onboarding Assistance: Guided setup and configuration assistance
- Performance Optimization: Configuration optimization consulting
- Custom Solutions: Custom configuration solutions for unique requirements
For detailed implementation guidance, proceed to the Data Mapping Overview and Integration Nuances sections.