Salesforce Connector
Connect to Salesforce to index CRM data including accounts, contacts, opportunities, and custom objects.
Overview
The Salesforce connector allows you to:
- Index standard and custom objects
- Query with SOQL filters
- Sync sharing permissions
- Access Salesforce Knowledge articles
Prerequisites
- Salesforce account (any edition)
- API access enabled
- OAuth app or user credentials
Authentication
OAuth 2.0 (Recommended)
- Click Connect with Salesforce
- Log in to your Salesforce org
- Authorize ZenSearch app access
Username/Password Flow
- Enter Salesforce username
- Enter password + security token
- Specify org type (production/sandbox)
Configuration
| Setting | Description |
|---|---|
| Environment | Production or Sandbox |
| Objects | Standard/custom objects to sync |
| SOQL Filter | Query filter for records |
| Instance URL | Salesforce instance URL (e.g., https://yourorg.my.salesforce.com) |
| API Version | Salesforce API version (e.g., v59.0) |
| Is Sandbox | Toggle between production and sandbox environments |
| Security Token | Security token required for username/password authentication |
| Custom Objects | Custom Salesforce objects to sync (API names) |
| Modified After | Only sync records modified after this date |
| Use Bulk API | Use Bulk API 2.0 for large datasets |
| Include Permissions | Sync record sharing rules for permission-aware search |
Setup Steps
- Add Connector: Knowledge → Add Data Source → Salesforce
- Authenticate: OAuth or username/password
- Select Objects: Choose objects to index
- Set Filters: Optional SOQL conditions
- Test & Create: Verify and save
Objects Indexed
| Object | Content |
|---|---|
| Accounts | Company information |
| Contacts | People records |
| Opportunities | Deal information |
| Cases | Support tickets |
| Knowledge | Help articles |
| Custom Objects | Your custom data |
SOQL Filtering
Filter records with SOQL:
Type = 'Customer' AND Industry != null
CreatedDate >= LAST_N_DAYS:90
RecordType.Name = 'Enterprise'
Permission Sync
Salesforce sharing rules are respected:
- Organization-wide defaults
- Role hierarchy
- Sharing rules
- Manual sharing
Best Practices
- Start with key objects (Accounts, Opportunities)
- Use SOQL filters to limit scope
- Include Knowledge articles if available
- Enable permission sync for security
Troubleshooting
Login failed: Check credentials and security token
API limits: Monitor daily API usage in Salesforce
Missing records: Verify SOQL filter and sharing rules