Custom CRM field mapping (Salesforce, Zendesk, Kustomer)
Stay organized with collections
Save and categorize content based on your preferences.
To allow metadata from CRM records to be analyzed quickly, the
Contact Center AI Platform (CCAI Platform) Web & Mobile SDKs can push data into CRM custom fields.
Custom CRM field mapping provides the ability to fully customize the CRM fields
and what data is pushed into those fields from the CCAI Platform Web &
Mobile SDKs.
Mobile SDK API example
The following sections outline an example specific to the mobile SDK.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThe Contact Center AI Platform (CCAI Platform) Web & Mobile SDKs can push metadata from CRM records into custom CRM fields for quick analysis, allowing for fully customizable field mapping.\u003c/p\u003e\n"],["\u003cp\u003eData is transferred from the SDK to the server and then to the CRM adapter, with examples provided for how the data is structured at each step, and CRM custom field mapping can be accessed and managed using an API.\u003c/p\u003e\n"],["\u003cp\u003eConfiguration steps involve creating custom fields in the CRM, assigning values to contacts, setting up the CCAI Platform portal, and then testing the setup.\u003c/p\u003e\n"],["\u003cp\u003eDetailed instructions are provided for configuring custom fields within Zendesk, Salesforce, and Kustomer CRMs, including specific steps for creating fields for users/contacts and tickets.\u003c/p\u003e\n"],["\u003cp\u003eThe CCAI Platform portal requires configuring the custom field mappings by adding the Field Mapping Title, CRM Field Label, and Custom Data Field Label within the CRM Custom Field Mapping section.\u003c/p\u003e\n"]]],[],null,["# Custom CRM field mapping (Salesforce, Zendesk, Kustomer)\n\nTo allow metadata from CRM records to be analyzed quickly, the\nContact Center AI Platform (CCAI Platform) Web \\& Mobile SDKs can push data into CRM custom fields.\n\nCustom CRM field mapping provides the ability to fully customize the CRM fields\nand what data is pushed into those fields from the CCAI Platform Web \\&\nMobile SDKs.\n\n### Mobile SDK API example\n\nThe following sections outline an example specific to the mobile SDK.\n\n#### Data from SDK to server\n\n {\n custom_data: { # same format with previous custom data from SDK\n data_name: {\n value: value,\n type: string,\n label: \"Data Name\",\n },\n device: { # example\n value: \"iOS\",\n type: \"string\",\n label: \"Device Type\"}\n }\n }\n\n#### Data from server to CRM adaptor\n\n {\n key: {\n crm_field: \"crm custom field name\",\n type: \"text\", # text / checkbox ...,\n value: \"value\"\n },\n device: { # example\n crm_field: \"device\",\n type: \"text\", \n value: \"iOS\"\n }\n }\n\n#### API endpoint\n\nThe CRM custom field mapping can be accessed using an API. The following\nendpoints are available:\n\n- **Retrieve all fields** : HTTP POST or GET: `/crm_custom_fields`\n\n- **Update or delete a specific field** : HTTP PUT or DELETE `/crm_custom_fields/:id`\n\n### Steps to configure\n\n1. Create the custom field and values in your CRM.\n\n2. Assign the new values to contacts in your CRM.\n\n3. Configure the setting in the CCAI Platform portal.\n\n4. Test.\n\n### Zendesk configuration\n\nThe following sections outline the process to configure field mappings for the\nZendesk CRM.\n\n#### Create a custom field for User (Contact)\n\n1. Sign in to Zendesk as an Admin.\n\n2. Click the settings to access the Admin options.\n\n3. Select **User Fields.**\n\n4. Select the field type that you want to create.\n\n1. Add a field title and name within an agent's view.\n\n | **Note:** We recommend using the same value as the **crm_field** from the API.\n\n **Field key** is filled automatically.\n2. Click **Create field**.\n\nYou can now see this new field in the **Active fields** list, and this new field\nappears in the left-side column when viewing a user.\n\n#### Create a custom field for Ticket\n\n1. Sign in to Zendesk as an Admin.\n\n2. Click the settings icon to access the\n Admin options.\n\n3. Select **Ticket Fields.**\n\n4. Click the **add custom field** button.\n\n5. Select a field type that you want to create by clicking **select**.\n\n6. Add a **Field Title** . The **Field Title** will appear in your\n Agent's view.\n\n We recommend using the same value as the **crm_field** from the\n API.\n\n7. Click the **Add field** button.\n\nYou can now see this new field in the **Active fields** list, and this new field\nappears in the left side column when viewing a ticket.\n\n### Salesforce configuration\n\n1. Go to **Setup.**\n\n2. Select **Object Manager**.\n\n3. Choose the object on which you want to append custom fields (Case\n or CCAI Platform Session).\n\n4. Click **Fields \\& Relationships**.\n\n5. Click **New**.\n\n6. Select **Text** as the Data Type.\n\n7. In **Field Label**, enter a name for the field.\n\n8. In **Length** , enter **255**.\n\n **Field Name** should automatically populate after you enter **Field\n Label**.\n\n You may leave the rest of the variables at their default value.\n9. Click **Next**.\n\n10. Check the **Visible** box for any of the profiles that access the\n object (Case or CCAI Platform Session).\n\n11. Click **Next**.\n\n12. Click **Save**.\n\n13. This will take you back to the **Fields \\& Relationships** view. Find\n the field that you just created, and take note of the **Field\n Name**.\n\n14. The **Field Name** is what you will enter in **CRM Field Label** in\n the CCAI Platform Custom Field Mapping page.\n\nThe following example shows what a **New field** will look like when correctly set\nup and used on the case object:\n\n### Kustomer configuration\n\nSee the Kustomer Help Center for details and information\nregarding setting up Custom Fields.\n\n### CCAI Platform configuration\n\nThe following sections outline the changes needed in the CCAI Platform portal to\nconfigure the Kustomer CRM field mapping.\n\n#### Add CRM field mapping\n\n1. In the CCAI Platform portal, go to **Settings \\\u003e Operation Management.**\n\n2. Go to the **CRM Custom Field Mapping** section and click **View All**.\n\n3. Click the + **Add CRM Field Mapping link.**\n\n - **Field Mapping Title:** CCAI Platform name for this custom field mapping\n used in the CCAI Platform Portal\n\n - **CRM Field Label:** Label within your CRM of the CRM field to\n which you are mapping\n\n - **Custom Data Field Label:** Label of the SDK data field from\n which you are mapping"]]