ticket_fields.csv

This page explains the configuration file of ticket fields.

Table of contents

• Sample
• Parameters
• The custom_field_options parameter

Sample

/example/configurations/ticket_fields.csv

Parameters

See also Zendesk official document, because parameters except slug are based on the Triggers API.
Details of custom_field_options are described in a later chapter.

Name	Type	Req. / Op.	Description
slug	string	Required	The identifier for Zenform ex. ticket_field_inquiry_category
title	string	Required	The name of the ticket field ex. Inquiry Category
type	string	Required	The type of the ticket field ex. tagger
visible_in_portal	bool	Optional	TRUE / true if visible to end users, otherwise FALSE / false.
editable_in_portal	bool	Optional	TRUE / true if editable by end users, otherwise FALSE / false
required_in_portal	bool	Optional	TRUE / true if required when end users edit, otherwise FALSE / false
description	string	Optional	The description of the ticket field for end users ex. Select inquiry category from below.
custom_field_options.names	string[]	Required	The parts of custom_field_options parameter
custom_field_options.values	string[]	Required	The parts of custom_field_options parameter

The custom_field_options parameter

custom_field_options is required when ticket field is a dropdown menu ( type is tagger ).
This parameter defines items in a dropdown menu.

Format of custom_field_options

Example

In ticket_fields.csv format, you can describe a dropdown menu which has 2 items ( Payment and Opinion ) as below.

custom_field_options.names	custom_field_options.values
["Payment","Opinion"]	["tag_payment","tag_opinion"]

name and value of each items are shown as below.

item	name	value
1st	Payment	tag_payment
2nd	Opinion	tag_opinion

Size Restriction

custom_field_options.fields and custom_field_options.values must be the same size.
In the previous example, both of them have 2 elements.

Format in Zendesk API

custom_field_options.names and custom_field_options.values are merged into an array and are sent as custom_field_options parameter in Zendesk API as below.

{
  ...
  "custom_field_options":[
    {"name":"Payment", "value":"tag_payment"},
    {"name":"Opinion", "value":"tag_opinion"}
  ]
  ...
}