Concepts

Concepts used in Zendesk book.

The following documentation is for Zendesk v3.3.0 (BDK).

Zendesk ticket

A ticket in Zendesk.

Field Name	Description	Type
id	The ID of the ticket.	optional[number]
assignee	The assignee of the ticket.	optional[zendesk user]
created_at	The creation date of the ticket.	optional[datetime]
custom_fields	List of custom fields as dictionaries with 'id' and 'value' keys.	optional[list of json]
description	The description of the ticket.	optional[text]
due_at	The due date of the ticket.	optional[datetime]
priority	The priority of the ticket.	optional[text]
requester_id	The ID of the requester.	optional[number]
submitter	The submitter of the ticket.	optional[zendesk user]
status	The status of the ticket.	optional[text]
subject	The subject of the ticket.	optional[text]
tags	The tags of the ticket.	optional[list of text]
type	The type of the ticket.	optional[text]
url	The URL of the ticket.	optional[text]

Zendesk user

A user in Zendesk.

Field Name	Description	Type
id	The ID of the user.	optional[number]
email	The email of the user.	optional[text]
name	The name of the user.	optional[text]

Zendesk comment

A comment in Zendesk.

Field Name	Description	Type
id	The ID of the comment.	optional[number]
body	The content/text of the comment.	optional[text]
author	The user who created the comment.	optional[zendesk user]
created_at	When the comment was created.	optional[datetime]
public	Whether the comment is public (true) or an internal note (false).	optional[boolean]
type	The type of comment (Comment, VoiceComment, etc.).	optional[text]
attachments	List of ZendeskAttachment objects.	optional[list of zendesk attachment]

Zendesk attachment

An attachment in Zendesk.

Field Name	Description	Type
id	The ID of the attachment.	optional[number]
file_name	The name of the file.	optional[text]
content_url	The URL to download the attachment content.	optional[text]
content_type	The MIME type of the attachment.	optional[text]
size	The size of the attachment in bytes.	optional[number]

Zendesk audit

An audit record for a ticket in Zendesk.

Field Name	Description	Type
id	The ID of the audit.	optional[number]
ticket_id	The ID of the ticket this audit belongs to.	optional[number]
created_at	When the audit was created.	optional[datetime]
author_id	The ID of the user who performed the action.	optional[number]
metadata	Additional metadata about the audit.	optional[json]
events	List of events in this audit (changes, comments, etc.).	optional[list of list of any?]

Zendesk ticket field

A custom field definition for Zendesk tickets.

Field Name	Description	Type
id	The ID of the ticket field.	number
title	The human-readable title of the field.	optional[text]
type	The type of the field (text, textarea, checkbox, dropdown, etc.).	optional[text]
description	The description of the field.	optional[text]
value	The actual value for this field on a specific ticket.	optional[any?]