Skip to content

Commit 6a99e42

Browse files
committed
ticket fields table cleanup
1 parent cf6be1c commit 6a99e42

File tree

1 file changed

+38
-25
lines changed
  • src/connections/sources/catalog/cloud-apps/zendesk

1 file changed

+38
-25
lines changed

src/connections/sources/catalog/cloud-apps/zendesk/index.md

Lines changed: 38 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Zendesk Source
33
id: 3hbak7a9
44
---
55

6+
<!-->
7+
68
[Zendesk](https://www.zendesk.com/){:target="_blank”} is a customer support platform that helps businesses manage and respond to customer requests across channels.
79

810
## Getting started
@@ -154,31 +156,35 @@ This collection contains information about Zendesk tickets.
154156

155157
### ticket_fields
156158

157-
| Property | Description |
158-
| --------------- | ----------------------------------------------------------------- |
159-
| id | This is automatically assigned upon creation. |
160-
| url | The URL for this resource. |
161-
| type | The type of the ticket field: “checkbox”, “date”, “decimal”, “integer”, “regexp”, “tagger”, “text”, or “textarea”. _*Type is not editable once created._ |
162-
| slug | The title of the ticket field separated by _. |
163-
| title | The title of the ticket field. |
164-
| raw_title | The dynamic content placeholder, if present, or the "title" value, if not. |
165-
| description | The description of the purpose of this ticket field shown to users. |
166-
| raw_description | The dynamic content placeholder, if present, or the “description” value, if not. |
167-
| position | A relative position for the ticket fields that determines the order of ticket fields on a ticket. Note that positions 0 to 7 are reserved for system fields. |
168-
| active | Whether this field is available. |
169-
| required | If it's required for this field to have a value when updated by agents.|
170-
| collapsed_for_agents | If this field should be shown to agents by default or be hidden alongside infrequently used fields. Classic interface only. |
171-
| regexp_for_validation | Regular expression field only. The validation pattern for a field value to be deemed valid. |
172-
| title_in_portal | The title of the ticket field when shown to end users. |
173-
| raw_title_in_portal | The dynamic content placeholder, if present, or the “title_in_portal” value, if not. |
174-
| visible_in_portal | Whether this field is available to end users. |
175-
| editable_in_portal | Whether this field is editable by end users. |
176-
| required_in_portal | If it's required for this field to have a value when updated by end users. |
177-
| tag | A tag value to set for checkbox fields when checked. |
178-
| removable | If this field is not a system basic field that must be present for all tickets on the account. |
179-
| created_at | The date and time the ticket field was created. |
180-
| updated_at | The date and time of the last update of the ticket field. |
181-
| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. |
159+
This collection contains information about Zendesk ticket fields.
160+
161+
| Property | Description |
162+
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
163+
| `id` | Automatically assigned when the ticket field is created. |
164+
| `url` | The API URL of the ticket field. |
165+
| `type` | The type of field. Possible values: `checkbox`, `date`, `decimal`, `integer`, `regexp`, `tagger`, `text`, `textarea`. This property can’t be edited after creation. |
166+
| `slug` | The title of the field, with words separated by underscores. |
167+
| `title` | The title of the ticket field. |
168+
| `raw_title` | The dynamic content placeholder if present, otherwise the `title` value. |
169+
| `description` | The purpose of the ticket field as shown to users. |
170+
| `raw_description` | The dynamic content placeholder if present, otherwise the `description` value. |
171+
| `position` | Determines the field’s order on the ticket. Positions 0–7 are reserved for system fields. |
172+
| `active` | Indicates whether the field is active. |
173+
| `required` | Indicates whether agents must provide a value when updating the field. |
174+
| `collapsed_for_agents` | Indicates whether the field is shown or hidden by default in the classic interface. |
175+
| `regexp_for_validation` | Validation pattern for regular expression fields. |
176+
| `title_in_portal` | The field title as shown to end users. |
177+
| `raw_title_in_portal` | The dynamic content placeholder if present, otherwise the `title_in_portal` value. |
178+
| `visible_in_portal` | Indicates whether the field is visible to end users. |
179+
| `editable_in_portal` | Indicates whether the field is editable by end users. |
180+
| `required_in_portal` | Indicates whether end users must provide a value when updating the field. |
181+
| `tag` | The tag value applied when a checkbox field is checked. |
182+
| `removable` | Indicates whether the field can be removed (system fields can’t be removed). |
183+
| `created_at` | The date and time the ticket field was created. |
184+
| `updated_at` | The date and time the ticket field was last updated. |
185+
| `received_at` | Timestamp added when data reaches the Segment API. |
186+
187+
-->
182188

183189
### ticket_metrics
184190

@@ -212,6 +218,7 @@ This collection contains information about Zendesk tickets.
212218
| latest_comment_added_at | The date and time the latest comment was added. |
213219
| received_ at | This timestamp is added to incoming messages as soon as they hit Segment API. |
214220

221+
215222
### ticket_events
216223

217224
| Property | Description |
@@ -229,6 +236,8 @@ This collection contains information about Zendesk tickets.
229236
| via | How the event was created. |
230237

231238

239+
240+
232241
### activities
233242

234243
| Property | Description |
@@ -240,6 +249,9 @@ This collection contains information about Zendesk tickets.
240249
| created_at | The date and time this record was created. |
241250
| updated_at | The date and time this record was last updated. |
242251

252+
253+
254+
243255
### attachments
244256

245257
| Property | Description |
@@ -252,6 +264,7 @@ This collection contains information about Zendesk tickets.
252264
| size | The size of the image file in bytes. |
253265
| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. |
254266

267+
255268
### organizations
256269

257270
| Property | Description |

0 commit comments

Comments
 (0)