Table of Contents

Search

  1. Preface
  2. Connectors and connections
  3. Connection configuration
  4. Connection properties
  5. Swagger file generation for REST V2 connections

Connections

Connections

Zendesk V2 connection properties

Zendesk V2 connection properties

When you set up a Zendesk V2 connection, configure the connection properties.
The following table describes the Zendesk V2 connection properties:
Property
Description
Connection Name
Name of the connection.
Each connection name must be unique within the organization. Connection names can contain alphanumeric characters, spaces, and the following special characters: _ . + -,
Maximum length is 255 characters.
Description
Description of the connection. Maximum length is 4000 characters.
Type
The Zendesk V2 connection type.
Runtime Environment
Name of the runtime environment where you want to run the tasks.
Specify a Secure Agent, Hosted Agent, or serverless runtime environment.
Username
Username of the Zendesk account.
Password
Password of the Zendesk account.
URL
URL of the Zendesk account. Specify the complete URL.
For example, https://informaticabusinesssolution13.zendesk.com/api/v2.
Enable Logging
Select the checkbox to enable logging.
Use Proxy
Connects to Zendesk through proxy server. Select the checkbox to use proxy server.
Custom Field
Specify custom fields for Zendesk objects.

Rules and guidelines for custom fields

Consider the following rules and guidelines when you configure a custom field:
  • Specify the custom fields in Zendesk using the following format, where FieldKey is value of the
    Field key
    in Zendesk:
    Object1=”FieldKey1,DataType,Size,Filterable,PrimaryKey”;”FieldKey2,DataType,Size,Filterable,PrimaryKey” Object2=”FieldKey1,DataType,Size,Filterable,PrimaryKey”;”FieldKey2,DataType,Size,Filterable,PrimaryKey”
    For example, you can specify the following custom fields for Organizations and Users objects:
    Organizations="support_description,String,255,true,false" Users="problems,String,255,true,false";age,Double,0,true,false";"required,Boolean,0,true,false";"select, String,255,true,false";"support_description,String,255,true,false";"reg_ex,String,255,true,false"
  • When you specify a custom field for Tickets object, you must specify the custom fields in the following format:
    Tickets=”CF_FieldID1,DataType,Size,Filterable,PrimaryKey”;”CF_FieldID2,DataType,Size,Filterable, PrimaryKey”
    For example:
    Tickets="CF_360003199614,String,255,true,false;"CF_360003373654,String,255,true,false"
  • Specify the custom fields for different objects in a new line.
  • When you specify multiple custom fields for an object, you must separate each custom field with a semicolon (;).
  • If you specify a size for a custom field, the agent considers the size of only the string data type. You must set the size for custom fields of other data types as zero.
  • The field key in a custom field must not contain special characters.
  • To find the field key for Tickets object in the Zendesk website, go to
    Settings
    Manage Ticket Fields
    .

0 COMMENTS

We’d like to hear from you!