Overview
Neon CRM Setup Requirements
Prerequisites and requirements for setting up the WeGive Neon CRM integration
Setup Requirements
Before configuring the WeGive Neon CRM integration, ensure you meet the following requirements and have completed the necessary preparatory steps.
Neon CRM Requirements
Account Prerequisites
- Active Neon CRM Account: Valid subscription with API access enabled
- API Access Level: Standard API access or higher (some features require advanced API access)
- Administrative Access: Account administrator permissions in Neon CRM
- API Key Generation: Ability to create and manage API keys
Technical Requirements
- API Version: Neon CRM API v2 support
- SSL/TLS: HTTPS connections required for all API communications
- Webhook Support: Ability to receive and process webhook notifications
- Data Export Permissions: Access to export account and donation data
Account Configuration
- Custom Fields: Review and document any custom fields that need mapping
- Data Structure: Understand existing account types (Individual vs Company)
- Campaign Setup: Existing campaigns and funds configured in Neon CRM
- User Permissions: Appropriate user roles and permissions for integration management
WeGive Platform Requirements
Organization Setup
- Active WeGive Account: Valid WeGive organization account
- Integration Access: Integration features enabled for your organization
- Administrative Rights: Organization administrator or integration manager permissions
- API Token Management: Ability to create and manage API tokens
Data Preparation
- Donor Data: Clean, consistent donor information in WeGive
- Campaign Structure: Defined campaigns and fundraising structures
- Payment Methods: Configured payment processing and methods
- Custom Fields: Any custom donor or transaction fields documented
Authentication Setup
Neon CRM API Credentials
-
API Key Generation:
- Log into your Neon CRM account
- Navigate to Account Settings > API Keys
- Generate a new API key with appropriate permissions
- Document the Organization ID and API Key
-
Required Permissions:
- Account read/write access
- Donation read/write access
- Campaign read/write access
- Webhook management access
WeGive Integration Token
- Token Creation:
- Access WeGive dashboard as organization administrator
- Navigate to Settings > Integrations
- Generate integration-specific API token
- Secure token storage and documentation
Network and Security Requirements
Firewall Configuration
- Outbound HTTPS: Allow connections to
api.neoncrm.com(production) - Outbound HTTPS: Allow connections to
trial.neoncrm.com(staging) - Inbound HTTPS: Allow webhook connections from Neon CRM servers
- Port Requirements: Standard HTTPS (port 443) access required
Security Considerations
- API Key Security: Secure storage of API credentials
- Token Rotation: Regular rotation of API keys and tokens
- Access Logging: Enable logging for integration activities
- SSL Certificates: Valid SSL certificates for webhook endpoints
Data Preparation
Donor Data Quality
- Email Addresses: Ensure all donors have valid, unique email addresses
- Name Fields: Complete first and last names for individual donors
- Organization Names: Complete names for company/organization donors
- Address Information: Standardized address formats when available
- Phone Numbers: Consistent phone number formatting
Campaign Structure
- Campaign Names: Clear, consistent campaign naming conventions
- Campaign Status: Properly configured active/inactive status
- Date Ranges: Appropriate start and end dates for campaigns
- Goals and Targets: Defined fundraising goals where applicable
Transaction History
- Payment Methods: Proper categorization of payment types
- Transaction Status: Clear success/failure status for all transactions
- Date Consistency: Accurate transaction and payment dates
- Amount Formatting: Consistent currency and decimal formatting
Custom Field Mapping Preparation
Field Analysis
- WeGive Custom Fields: Document all custom fields in WeGive
- Neon Custom Fields: Document all custom fields in Neon CRM
- Mapping Requirements: Identify fields requiring bidirectional sync
- Data Types: Ensure compatible data types between platforms
Mapping Planning
- Priority Fields: Identify critical fields for immediate mapping
- Optional Fields: Document nice-to-have field mappings
- Transformation Rules: Plan any required data transformations
- Validation Rules: Define data validation requirements
Environment Configuration
Testing Environment
- Neon Trial Account: Access to Neon CRM trial/staging environment
- WeGive Staging: Access to WeGive staging environment
- Test Data: Sample data for integration testing
- Rollback Plan: Strategy for reverting changes if needed
Production Readiness
- Backup Strategy: Data backup plan before integration activation
- Monitoring Setup: Integration monitoring and alerting configuration
- Staff Training: Team training on integrated workflows
- Documentation: Complete integration documentation for team reference
Pre-Integration Checklist
Technical Verification
- Neon CRM API credentials obtained and tested
- WeGive integration token generated and secured
- Network connectivity to both platforms verified
- Webhook endpoints configured and accessible
- SSL certificates valid and properly configured
Data Readiness
- Donor data quality reviewed and cleaned
- Campaign structure documented and organized
- Transaction history verified and consistent
- Custom fields documented and mapped
- Test data prepared for integration testing
Administrative Preparation
- Integration permissions granted to appropriate users
- Backup procedures established and tested
- Staff training scheduled and completed
- Go-live plan documented and approved
- Rollback procedures defined and tested
Common Setup Issues
Authentication Problems
- Invalid Credentials: Double-check API keys and organization IDs
- Permission Errors: Ensure appropriate permissions for integration user
- Token Expiration: Verify API tokens are current and valid
- SSL Issues: Confirm SSL certificates and connections
Data Quality Issues
- Duplicate Emails: Resolve duplicate email addresses before integration
- Missing Required Fields: Ensure all required fields are populated
- Inconsistent Formatting: Standardize data formats between platforms
- Invalid Data Types: Correct data type mismatches
Network Connectivity
- Firewall Blocking: Verify firewall rules allow required connections
- DNS Resolution: Ensure proper DNS resolution for API endpoints
- Webhook Delivery: Test webhook endpoint accessibility
- Rate Limiting: Understand and configure appropriate API rate limits
Support Resources
Documentation
- Neon CRM API Documentation
- WeGive API Documentation
- Integration Configuration Guide
- Data Mapping Reference
Technical Support
- WeGive Support: [email protected]
- Neon CRM Support: Available through your Neon CRM account
- Integration Help: Specialized integration support available
- Training Resources: Integration training and best practices
Next Steps
After completing these setup requirements:
- Proceed to Configuration Options
- Review Data Mapping Documentation
- Understand Integration Nuances
- Begin integration testing in staging environment
- Plan production deployment and monitoring
Proper preparation and setup ensure a smooth integration experience and optimal ongoing performance between WeGive and Neon CRM.