Configuring Data Sync from Salesforce to Zendesk

The Zendesk for Salesforce integration provides one-way data sync from Salesforce to Zendesk Support. This article describes how to set up two types of data sync:

• Salesforce accounts to Zendesk organizations — Zendesk organizations in Support are automatically created and updated when Salesforce Accounts are created or modified.
• Salesforce Contacts or Leads to Zendesk users — Zendesk users in Support are automatically created and updated when Salesforce Contacts or Leads are created or modified.

This article contains the following sections:

• Understanding the data sync process
  • Salesforce Accounts to Zendesk Organizations sync
  • Salesforce Contacts or Leads to Zendesk users sync
• Setting up a data sync
  • Configuring your Salesforce API settings and permissions
  • Configuring Salesforce Accounts to Zendesk Organizations sync
  • Configuring Salesforce Contacts or Leads to Zendesk users sync
• Understanding sync filtering
• Understanding matching criteria
• Understanding field mapping
  • Salesforce Accounts to Zendesk organizations field mapping
  • Salesforce Contacts or Leads to Zendesk users field mapping
• Checking your data sync setup

Related articles:

• Salesforce integration resources

Understanding the data sync process

A data sync is triggered when a mapped field is updated in an existing Salesforce record, or a new record is created. Any unmapped fields that are updated do not trigger the sync.

When a Salesforce record is created or changed, the syncing process attempts to establish whether a new record in Support should be created, or if an existing record should be updated. This is done by comparing field values based on the defined criteria.

Once a successful match of existing records has been made, or a new record has been created in Support, the Salesforce record and the Support record are linked. This means that subsequent updates to the record in Salesforce doesn't use matching criteria, but instead updates the linked record in Support.

If more than one matching result is found, the sync is unable to determine which record needs to be updated. Because this is a background process, the ongoing sync won't update any of the records, and logs an unsuccessful sync event.

A sync is triggered to Zendesk when records are created or updated to a mapped field, either in bulk or via the Salesforce API.

Since data syncing is one-way, any changes applied in Zendesk are not reflected in Salesforce.

Salesforce Accounts to Zendesk Organizations sync

The Salesforce Account to Zendesk organization sync is one-for-one sync, and by default uses account name to organization name for matching records. However, not all Salesforce implementations adhere to this rule. So if you have duplicate account names, you can change this to another account field that is unique. This might not be the suitable feature if you don’t have unique account fields.

This data sync has the following limitations:

• The integration does not support Salesforce Person accounts. All accounts are treated as organizations in Zendesk.
• Data sync consumes Salesforce streaming API governor limits. For example, if you have a large amount of data to be synced, this exceeds the governor limit and data may not sync.

Salesforce Contacts or Leads to Zendesk users sync

The sync from Salesforce Contacts or Leads to Zendesk users is one-for-one, based on unique email addresses. However, not all Salesforce implementations adhere to these rules, so consider if this feature is suitable for your needs.

This data sync feature has the following limitations:

• The integration does not support Salesforce Person accounts. All accounts are treated as organizations in Zendesk
• Data sync consumes Salesforce streaming API governor limits. For example, if you have a large amount of data to be synced, this exceeds the governor limit and data may not sync

Note:

If you have multiple Salesforce contacts with the same email address which belong to different Accounts and you want to sync to a user in Zendesk, use the multiple organizations feature in Support. For more information, see Using the multiple organizations feature in the Salesforce integration.

Setting up a data sync

Setting up a data sync requires performing several tasks in Salesforce and the Zendesk Admin Center.

To set up data sync for your integration

1. Set up the Zendesk for Salesforce integration.
2. Configure Salesforce API settings and permissions for syncing.
3. In Admin Center, configure sync settings for Salesforce Accounts to Zendesk organizations and / or Salesforce Contacts or Leads to Zendesk users.

Configuring your Salesforce API settings and permissions

Before setting up a data sync, some Salesforce APIs settings and permissions must be enabled for data sync to be successful. The information in the following procedures is described for the Salesforce Lightning edition.

To enable the Salesforce API

1. On the Salesforce Setup page, select Administration > Users > Profiles.
2. Select System Administrator or the authenticated user's profile.
3. Click System Permissions and select the API enabled checkbox.
   

To set streaming API channel permissions

1. On the Salesforce Setup page, select Administration > Users > Profile.
2. Select the Standard User profile.
3. Click Object Settings > Streaming Channels, and under Object Permissions, select the Read checkbox.
   

To set Push Topic permissions

1. On the Salesforce Setup page in the left sidebar, select Administration > Users > Profile.
2. Select the Standard User profile.
3. Click Object Settings > Push Topic, and click Edit.
4. Under Object Permissions, select the Read checkbox, and click Save.
   

To enable Streaming API

1. On the Salesforce Setup page in the left sidebar, select Platform tools > User Interface > User Interface.
2. Under Setup, select the Enable Streaming API checkbox.
   

Configuring Salesforce Accounts to Zendesk Organizations sync

The following procedure explains setting up a sync so Zendesk organizations in Support are automatically created and updated when Salesforce accounts are created or modified.

Important: This is an advanced feature. Once data is synced from Salesforce to Zendesk, it is not reversible. We highly recommend that you test this feature first.

To configure Salesforce accounts to Zendesk organization sync

1. In Admin Center, select Integrations in the left navigation pane.
2. In Salesforce, click Configure.
3. Click the Data Sync side tab, and in Accounts to Organizations sync, click Configure.
4. Select the Enable syncing checkbox, and configure the settings for which Accounts and Account fields are synced to Zendesk.
5. In Sync Filtering, configure conditional filters to define which Salesforce Accounts are synced to Zendesk. For more information, see Understanding sync filtering.
6. In Matching criteria, set the criteria for matching Salesforce accounts to Zendesk organizations. For more information, see Understanding matching criteria.
7. In Field mapping, map which Salesforce account fields you want to populate with the Zendesk organization field. For more information, see Understanding field mapping.
8. In Synced Organization ID Mapping, you can choose to map the Zendesk organization ID to a Salesforce Account. Select from any standard and custom Salesforce Account field. This is a one-way sync useful for displaying which Zendesk organization is linked to a Salesforce Account. Once the ID has been synced between two records it cannot be changed and editing or deleting the ID in the Salesforce field will not change or remove the link. 
   Note: If you change the mapped field, it will only be used for syncing after the change. Any previously updated syncs will not be updated to sync the ID to the new field.
9. In Zendesk external ID, select the checkbox if you want the external ID to populate the Zendesk organization external ID field. By default, this is mapped to the Salesforce Account ID.
   Note: Any existing external ID values are overridden and cannot be reverted. This may impact other applications that rely on this field. This change is only applied when you click Save.
10. Click Save to save your configuration. Confirmation of saved settings is displayed.

Configuring Salesforce Contacts or Leads to Zendesk users sync

The following procedure explains configuring a sync so Zendesk users in Support are automatically created and updated when Salesforce Contacts or Leads are created or modified.

Note: For Zendesk user records to be automatically mapped to their corresponding organizations upon a users sync, both Contacts / Leads to Users sync and Accounts to Organizations sync must be enabled.

To configure Salesforce Contacts or Leads to Zendesk user sync settings

1. In Admin Center, select the Integrations icon () in the left navigation pane.
2. In Salesforce, click Configure.
3. Click the Data Sync side tab, and in Contacts / Leads to User sync, click Configure.
4. Select the Enable syncing checkbox, and configure the settings for which Contacts or Leads and associated fields are synced to Zendesk.
5. In Sync Type, select if you want Zendesk users to be created based on Salesforce Contacts or Leads. Note that you can only select one.
6. In Sync Filtering, configure conditional filters to choose which Salesforce Contacts or Leads accounts are synced to Zendesk. For more information, see Understanding sync filtering.
7. In Matching criteria, set the criteria for matching Salesforce Contacts or Leads to Zendesk users. For more information, see Understanding matching criteria.
8. In Field mapping, map which Salesforce Contact or Lead fields you want to populate with Zendesk organization field. For more information, see Understanding field mapping.
9. In Synced Contact/Lead ID Mapping, you can choose to map the Zendesk user ID to a Salesforce Contact/Lead. Select from any standard and custom Salesforce Contact/Lead field. This is a one-way sync useful for displaying which Zendesk user is linked to a Salesforce Contact. Once the ID has been synced between two records it cannot be changed and editing or deleting the ID in the Salesforce field will not change or remove the link. 
   Note: If you change the mapped field, it will only be used for syncing after the change. Any previously updated syncs will not be updated to sync the ID to the new field.
10. In Zendesk external ID, select the checkbox if you want the external ID to populate the Zendesk organization external ID field. By default, this is mapped to the Salesforce Account ID.
    Note: Any existing external ID values are overridden and cannot be reverted. This may impact other applications that rely on this field. This change is only applied when you click Save.
11. In General options, select the Send welcome email checkbox to send a welcome email to new users in Support. For more information, see Customizing the welcome email and the account verification email.
12. Click Save to save your configuration. Confirmation of saved settings is displayed.

Understanding sync filtering

In the Data Sync > Sync Filtering section, you can apply a filter to choose which Salesforce accounts are synced to Zendesk, or choose which Salesforce Contacts or Leads accounts are synced to Zendesk. You can control the sync by building conditional statements. If no filters are set, all accounts are in scope for syncing.

To create a sync filter condition, specify the field, the operator, and the value:

• Meet ALL of the following conditions: All of the conditions added to this section must be met to include the Salesforce record in the sync.
• Meet ANY of the following conditions: One or more of the conditions in this section must be met to include the Salesforce record in the sync.

Note the sync filter values has the following syntax rules:

• All values are case sensitive
• Multiple values in a condition can be separated by a comma, with no spaces
• When using a Salesforce picklist field in sync filter, the value must be the API name of the pick list options
• When a checkbox type field is used as a condition, enter a value of "true'" or "false"
  

The following Salesforce fields are not supported for filtering:

• Formula field
• Lookup field
• Long text area field

Understanding matching criteria

In the Data sync > Matching criteria section, the criteria is set for matching Salesforce Accounts to Zendesk organizations, or Salesforce Contacts or Leads to Zendesk users. When a record in Salesforce is created or changed, the syncing process checks whether a new organization or user record in Support should be created, or an existing organization or user record should be updated. This is done by comparing the values set in the matching criteria that you set. When a match is found, the corresponding fields are updated according to your field mapping settings.

The options in the Zendesk field drop-down vary according to the type of field you select in the Salesforce drop-down. Standard and custom fields are supported for matching.

Note:

• Only one matching criteria is supported. Adding multiple matching criteria will be available in the future.
• If more than one matching result is found, the sync won't be successful since it can't determine which record needs to be updated. In this case, ongoing sync won't update any records, and logs an unsuccessful sync event.

Understanding field mapping

The field mapping sections enable Salesforce fields to be mapped to Zendesk fields. You can map to standard and custom Zendesk fields. The mapped fields are updated during the sync.

The following Salesforce fields are not supported for mapping:

• Long text area field
• Lookup field — Salesforce lookup fields cannot be mapped to Zendesk because the lookup fields values are stored in a related Salesforce object
• Record type ID
• Number field

Salesforce Accounts to Zendesk organizations field mapping

In Data Sync > Accounts to Organizations sync, the Field mapping section maps Salesforce account fields you want to populate with Zendesk organization fields. This controls which field in the Salesforce account record is synced as its related organization name. By default, this is set to Account Name to Organization Name.

The drop-down options in the Zendesk field vary according to the type of field you select in the Salesforce drop-down. The following table shows which Salesforce fields types can be mapped to Zendesk field types.

Salesforce field type	Text	Drop-down	Decimal	Checkbox	Date	Numeric
ID	✓
String	✓
Phone	✓
Picklist	✓	✓
Currency	✓		✓
Boolean	✓			✓
Checkbox				✓
Date/Time	✓				✓
Number	✓					✓
Double	✓		✓
Date	✓				✓
Multi picklist	✓
Email	✓

Salesforce Contacts or Leads to Zendesk users field mapping

In Data Sync > Accounts to Organizations sync, the Field mapping section maps Salesforce Contact or Lead fields you want to populate with Zendesk organization fields. This identifies which field in the Salesforce Contact or Lead account record is synced as its related user. By default, field mapping is set to Email to Email.

The drop-down options in the Zendesk field vary according to the type of field you select in the Salesforce drop-down. The following table shows which Salesforce fields types can be mapped to Zendesk field types.

Salesforce field type	Text	Drop-down	Decimal	Checkbox	Date	Numeric
ID	✓
String	✓
Phone	✓
Picklist	✓	✓
Currency	✓		✓
Boolean	✓			✓
Checkbox				✓
Date/Time	✓				✓
Number	✓					✓
Double	✓		✓
Date	✓				✓
Multi picklist	✓
Email	✓

Checking your data sync setup

Use the following checklist to help check your data sync is setup correctly:

1. Check you have the right Salesforce API settings requirements when setting up the integration.
2. Sync filter: Confirm you are not using any unsupported Saleforce fields such as Formula Field and Lookup field.
3. Sync filter : Confirm you are using the correct syntax in the sync filter values. These are case sensitive and must exactly match the Salesforce field value. If you are using a Salesforce picklist field for filtering, the value is the API name.
4. Sync field mapping: Check the field mapping includes Name to Name. This is mandatory because organizations can't be created in Zendesk without a name.
5. When testing the sync, did you make updates to the Salesforce fields that are mapped to Zendesk? Sync is only triggered when a mapped field is updated.