Zendesk Support Field Reference
Sample
This connector fetches data from Zendesk on a support case level.
https://connectors.windsor.ai/zendesk_support?api_key=[API_KEY]&fields=url,id,external_id,via,created_at,updated_at,type,subject,raw_subject,description,priority,status,recipient,requester_id,submitter_id,assignee_id,organization_id,group_id,collaborator_ids,follower_ids,email_cc_ids,forum_topic_id,problem_id,has_incidents,is_public,due_at,tags,custom_fields,satisfaction_rating,sharing_agreement_ids,followup_ids,brand_id,allow_channelback,allow_attachments,updated_stamp
Fields
| ID | Type | Name | Description |
|---|---|---|---|
| allow_attachments | BOOLEAN | Allow Attachments | Permission for agents to add add attachments to a comment. Defaults to true. |
| allow_channelback | BOOLEAN | Allow Channelback | Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket. |
| assignee_email | TEXT | Assignee Email | Write only. The email address of the agent to assign the ticket to. |
| assignee_id | TEXT | Assignee Id | The agent currently assigned to the ticket. |
| attribute_value_ids | TEXT | Attribute Value Ids | Write only. An array of the IDs of attribute values to be associated with the ticket. |
| brand_id | TEXT | Brand Id | Enterprise only. The id of the brand this ticket is associated with. |
| collaborator_ids | TEXT | Collaborator Ids | The ids of users currently CC'ed on the ticket. |
| collaborators | TEXT | Collaborators | POST requests only. Users to add as cc's when creating a ticket. |
| comment | TEXT | Comment | Write only. An object that adds a comment to the ticket. |
| created_at | DATE | Created At | When this record was created. |
| custom_fields | TEXT | Custom Fields | Custom fields for the ticket. |
| custom_status_id | TEXT | Custom Status Id | The custom ticket status id of the ticket. |
| date | DATE | Date | Alias for Created At. |
| description | TEXT | Description | Read-only first comment on the ticket. When creating a ticket, use comment to set the description. |
| due_at | DATE | Due At | If this is a ticket of type task it has a due date. |
| email_cc_ids | TEXT | Email cc Ids | The ids of agents or end users currently CC'ed on the ticket. |
| email_ccs | TEXT | Email ccs | Write only. An array of objects that represent agent or end users email CCs to add or delete from the ticket. |
| external_id | TEXT | External Id | An id you can use to link Zendesk Support tickets to local records. |
| follower_ids | TEXT | Follower Ids | The ids of agents currently following the ticket. |
| followers | TEXT | Followers | Write only. An array of objects that represent agent followers to add or delete from the ticket. |
| followup_ids | TEXT | Followup Ids | The ids of the followups created from this ticket. Ids are only visible once the ticket is closed. |
| forum_topic_id | TEXT | Forum Topic Id | The topic in the Zendesk Web portal this ticket originated from, if any. The Web portal is deprecated. |
| group_id | TEXT | Group Id | The group this ticket is assigned to. |
| has_incidents | BOOLEAN | Has Incidents | Is true if a ticket is a problem type and has one or more incidents linked to it. Otherwise, the value is false. |
| id | TEXT | ID | Automatically assigned when the ticket is created. |
| is_public | BOOLEAN | Is Public | Is true if any comments are public, false otherwise. |
| macro_id | TEXT | Macro Id | Write only. A macro ID to be recorded in the ticket audit. |
| macro_ids | TEXT | Macro Ids | POST requests only. List of macro IDs to be recorded in the ticket audit. |
| metadata | TEXT | Metadata | Write only. Metadata for the audit. In the audit object, the data is specified in the custom property of the metadata object. |
| organization_id | TEXT | Organization Id | The organization of the requester. You can only specify the ID of an organization associated with the requester. |
| priority | TEXT | Priority | The urgency with which the ticket should be addressed. Allowed values are urgent, high, normal, or low. |
| problem_id | TEXT | Problem Id | For tickets of type incident, the ID of the problem the incident is linked to. |
| raw_subject | TEXT | Raw Subject | The dynamic content placeholder, if present, or the subject value, if not. |
| recipient | TEXT | Recipient | The original recipient e-mail address of the ticket. Notification emails for the ticket are sent from this address. |
| requester | TEXT | Requester | Write only. |
| requester_id | TEXT | Requester Id | The user who requested this ticket. |
| safe_update | BOOLEAN | Safe Update | Write only. Optional boolean. Prevents updates with outdated ticket data (updated_stamp property required when true). |
| satisfaction_rating | TEXT | Satisfaction Rating | The satisfaction rating of the ticket, if it exists, or the state of satisfaction, offered or unoffered. The value is null for plan types that don't support CSAT. |
| sharing_agreement_ids | TEXT | Sharing Agreement Ids | The ids of the sharing agreements used for this ticket. |
| status | TEXT | Status | The state of the ticket. Allowed values are new, open, pending, hold, solved, or closed. |
| subject | TEXT | Subject | The value of the subject field for this ticket. |
| submitter_id | TEXT | Submitter Id | The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket. |
| tags | OBJECT | Tags | The array of tags applied to this ticket. |
| ticket_form_id | TEXT | Ticket Form Id | Enterprise only. The id of the ticket form to render for the ticket. |
| type | TEXT | Type | The type of this ticket. Allowed values are problem, incident, question, or task. |
| updated_at | DATE | Updated At | When this record last got updated. |
| updated_stamp | DATE | Updated Stamp | Write only. Datetime of last update received from API. |
| url | TEXT | URL | The API url of this ticket. |
| via | TEXT | Via | For more information, see the Via object reference |
| via_followup_source_id | TEXT | Via Followup Source Id | POST requests only. The id of a closed ticket when creating a follow-up ticket. |
| via_id | TEXT | Via Id | For more information, see the Via object reference |
| voice_comment | TEXT | Voice Comment | Write only. See Creating voicemail ticket. |