Working with Zendesk Custom Fields

Published: Oct 02, 2025

Working with Zendesk Custom Fields

Published: Oct 02, 2025

The Zendesk Connector has access to all the standard ticket fields. If integration with custom fields is required, these steps can be followed.

Add field to REST Data Source Definition

Retrieve the custom field key from Zendesk
  1. Log into Zendesk.
  2. Open the Admin Center.
  3. Navigate to People > Configuration > User fields.
  4. Locate the field you need to return in the data source.
  5. Save the Field key for reference in your data source below.
Add the Custom Field as a Data Source Field
  1. Log into SmartConnect > Maintenance > REST Services.
  2. Edit the Zendesk REST Service.
  3. Select Data Sources and edit the user data source you will modify.
  1. Scroll to the bottom of the Field list.
  2. Enter a friendly display name for the field and add a path of users.user_fields.<<field key>>. Replacing <<field key>> with the value of the custom field key.
  3. Save the data source
Retrieve the custom field key from Zendesk
  1. Log into Zendesk.
  2. Open the Admin Center.
  3. Navigate to People > Configuration > Organization fields.
  4. Locate the field you need to return in the data source.
  5. Save the Field key for reference in your data source below.
Add the Custom Field as a Data Source Field
  1. Log into SmartConnect > Maintenance > REST Services.
  2. Edit the Zendesk REST Service.
  3. Select Data Sources and edit the organization data source you will modify.
  1. Scroll to the bottom of the Field list.
  2. Enter a friendly display name for the field and add a path of organizations.organization_fields.<<field key>>. Replacing <<field key>> with the value of the custom field key.
  3. Save the data source
Retrieve the custom field id from Zendesk
  1. Log into Zendesk.
  2. Open the Admin Center.
  3. Navigate to Objects and rules > Tickets > Fields.
  4. Locate the field you need to return in the data source.
  5. Save the Field ID for reference in your script below.
Add the Custom Fields array as a Data Source Field
  1. Log into SmartConnect > Maintenance > REST Services.
  2. Edit the Zendesk REST Service.
  3. Select Data Sources and edit the ticket data source you will modify.
  1. Select the Fields tab and a new field named custom_fields with a type of ValueArray as show below.
TicketCustomFieldsArray
  1. Click Save.
Add a Source Calculation to extract field value
  1. On the Data Sources > Fields tab scroll to the bottom and click Add Calculated Field
  2. Set the Field Name to a name that is easy for you to find.
  3. Set the Field Type to String.
  4. Enter the below Script in the window.
  5. On the second line of script replace myFieldId with the Field Id for your field.
//Replace the value below with the unique Id for your custom Zendesk field
var myFieldId = 4417362012691

//do not edit below code
var list = eval(<<custom_fields>>);
if(list.length == 0) return '';
for(var I = 0; I < list.length; I++){
  var item = list[I];
  if(item.id == myFieldId)
    return item.value;
}
return '';
  1. Save the Data Source Setup

Add field to Data Source Query

  1. Navigate to the Data Source setup screen for your data source.
  2. Click add data source or select your existing data source.
  3. Click Select Fields add the custom field to the data source.
  4. Preview and verify data is returned for the column.
  5. Save the data source.
Content
Add field to REST Data Source Definition Add field to Data Source Query

Feeling stuck? Get the support and guidance you need to help you power through any data challenge

Reset Filters