Skip to content

Commit ad8d710

Browse files
committed
organizations + ticket comments
1 parent 23de286 commit ad8d710

File tree

1 file changed

+32
-30
lines changed
  • src/connections/sources/catalog/cloud-apps/zendesk

1 file changed

+32
-30
lines changed

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

Lines changed: 32 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -265,42 +265,44 @@ This collection contains information about files attached to Zendesk tickets.
265265
| `size` | The file size in bytes. |
266266
| `received_at` | Timestamp added when data reaches the Segment API. |
267267

268+
### organizations
268269

270+
This collection contains information about organizations in Zendesk.
271+
272+
| Property | Description |
273+
| ----------------- | ----------------------------------------------------------------------------------------- |
274+
| `id` | Automatically assigned when the organization is created. |
275+
| `external_id` | A unique external ID that links the organization to an external record. |
276+
| `url` | The API URL of the organization. |
277+
| `name` | The unique name of the organization. |
278+
| `details` | Additional details about the organization, such as its address. |
279+
| `notes` | Notes or comments about the organization. |
280+
| `group_id` | The group that new tickets from users in this organization are automatically assigned to. |
281+
| `shared_tickets` | Indicates whether end users in the organization can view each other’s tickets. |
282+
| `shared_comments` | Indicates whether end users in the organization can view each other’s ticket comments. |
283+
| `created_at` | The date and time the organization was created. |
284+
| `updated_at` | The date and time the organization was last updated. |
285+
| `received_at` | Timestamp added when data reaches the Segment API. |
269286

270-
-->
287+
### ticket_comments
271288

289+
This collection contains comments and related metadata for Zendesk tickets.
272290

273-
### organizations
291+
| Property | Description |
292+
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
293+
| `id` | Automatically assigned when the comment is created. |
294+
| `ticket_event_id` | Automatically assigned when the comment is created. |
295+
| `ticket_id` | The ID of the ticket the comment belongs to. |
296+
| `type` | The comment type. Possible values: `Comment` or `VoiceComment`. JSON objects for voice comments differ in structure. |
297+
| `body` | The text of the comment. |
298+
| `public` | Indicates whether the comment is public (`true`) or internal (`false`). The initial value set on ticket creation persists unless changed. |
299+
| `author_id` | The ID of the comment author. |
300+
| `via` | How the comment was created. |
301+
| `created_at` | The date and time the comment was created. |
302+
| `received_at` | Timestamp added when data reaches the Segment API. |
274303

275-
| Property | Description |
276-
| --------------- | ----------------------------------------------------------------- |
277-
| id | This is automatically assigned when the organization is created. |
278-
| external_id | A unique external ID to associate organizations to an external record. |
279-
| url | The API URL of this organization. |
280-
| name | A unique name for the organization. |
281-
| details | This includes any details about the organization, such as the address. |
282-
| notes | Any notes you have about the organization. |
283-
| group_id | New tickets from users in this organization are automatically put in this group. |
284-
| shared_tickets | End users in this organization are able to see each other's tickets. |
285-
| shared_comments | End users in this organization are able to see each other's comments on tickets. |
286-
| created_at | The date and time that the organization was created. |
287-
| updated_at | The date and time that the organization was last updated. |
288-
| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. |
289304

290-
### ticket_comments
291-
292-
| Property | Description |
293-
| --------------- | ----------------------------------------------------------------- |
294-
| id | This is automatically assigned when the comment is created. |
295-
| ticket_event_id | This is automatically assigned when the comment is created. |
296-
| ticket_id | The ID of the ticket being commented. |
297-
| type | Comment or VoiceComment. The JSON object for voice comments is different. |
298-
| body | The comment string. |
299-
| public | true if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it. |
300-
| author_id | The ID of the comment author. |
301-
| via | How the comment was created. |
302-
| created_at | The time the comment was created. |
303-
| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. |
305+
-->
304306

305307
### ticket_forms
306308
> warning "This collection requires Zendesk Enterprise access"

0 commit comments

Comments
 (0)