Skip to content

Commit 7a748ec

Browse files
pwsegpwseg
committed
clean up collections table
1 parent 473e9b3 commit 7a748ec

File tree

1 file changed

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

1 file changed

+21
-25
lines changed

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

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

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

108
## Getting started
@@ -43,28 +41,26 @@ At the moment, Segment doesn't support filtering which objects or properties get
4341

4442
## Collections
4543

46-
Collections are the groupings of resources Segment pulls from your source.
47-
48-
49-
| Collection | Type | Description |
50-
| ----------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
51-
| [users](#users) | object | Zendesk Support has three types of users: end-users (your customers), agents, and administrators. End-users request support through tickets. Agents work in Zendesk Support to solve tickets. Agents can be divided into multiple groups and can also belong to multiple groups. Agents don't have access to administrative configuration in Zendesk Support such as business rules or automation, but can configure their own macros and views. Administrators have all the abilities of agents, plus administrative abilities. |
52-
| [groups](#groups) | object | When support requests arrive in Zendesk, they can be assigned to a Group. Groups serve as the core element of ticket workflow; support agents are organized into Groups and tickets can be assigned to a Group only, or to an assigned agent within a Group. A ticket can never be assigned to an agent without also being assigned to a Group. |
53-
| [tickets](#tickets) | object | Tickets are the means through which your End-users (customers) communicate with Agents in Zendesk. **Note**: Segment pulls all tickets updated (or created) in the last year to start by default. If you need more, reach out to [Segment support](https://segment.com/help/contact/){:target="_blank”}. Support can do a run to pull further back in history. |
54-
| [ticket_fields](#ticket_fields) | object | Customize fields on the ticket form. |
55-
| [activities](#activities) | object | The activity stream is a per agent event stream. It will give access to the most recent events that relate to the agent polling the API. |
56-
| [attachments](#activities) | object | This API is for attachments in tickets and forum posts in the Web portal. |
57-
| [organizations](#organizations) | object | Just as agents can be segmented into groups in Zendesk, your customers (end-users) can be segmented into organizations. |
58-
| [ticket_events](#ticket_events) | events | Returns a stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change. **Note**: Segment pulls one year of ticket events to start by default. If you need more, reach out to [Segment support](https://segment.com/help/contact/){:target="_blank”}. Support can do a run to pull further back in history. |
59-
| [ticket_metrics](#ticket_metrics) | object | All kinds of aggregate metrics about a ticket |
60-
| [satisfaction_ratings](#satisfaction_ratings) | object | If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings. |
61-
| [ticket_comments](#ticket_comments) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/){:target="_blank”}. |
62-
| [ticket_forms](#ticket_forms) | object | Ticket forms allow an admin to define a subset of ticket fields for display to both agents and end users. **Note**: This feature requires a Zendesk Enterprise account. Segment fully syncs all available records in each sync run. |
63-
| [ticket_skips](#ticket_skips) | object | A skip is a record of when an agent skips over a ticket without responding to the end user. **Note**: Segment fully syncs all available records in this collection during each sync run. |
64-
| [organization_memberships](#organization_memberships) | object | An organization_membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. **Note**: Segment fully syncs all available records in this collection during each sync run. |
65-
| [group_memberships](#group_memberships) | object | A group_membership links an agent to a group. Groups can have many agents, as agents can be in many groups. **Note**: Segment fully syncs all available records in this collection during each sync run. |
66-
| [audit_logs](#audit_logs) | object | The audit log shows various changes in your instance of Zendesk since the account was created. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/){:target="_blank”}. |
67-
44+
The following collections show the Zendesk objects Segment syncs into your warehouse. Each collection includes standard properties from Zendesk and any custom fields defined in your account.
45+
46+
| Collection | Type | Description |
47+
| ----------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
48+
| [users](#users) | object | Zendesk has three user types: end users (customers), agents, and administrators. End users request support through tickets. Agents work to resolve tickets and can belong to multiple groups. Administrators have full agent permissions plus configuration access. |
49+
| [groups](#groups) | object | Groups organize agents and define ticket assignment workflows. A ticket must always be assigned to a group, even if it’s also assigned to a specific agent. |
50+
| [tickets](#tickets) | object | Tickets let end users communicate with agents. Segment pulls tickets created or updated within the last year by default. To load older data, contact [Segment Support](https://segment.com/help/contact/){:target="_blank"}. |
51+
| [ticket_fields](#ticket_fields) | object | Custom fields added to the ticket form. |
52+
| [activities](#activities) | object | Per-agent activity stream showing recent ticket-related events. |
53+
| [attachments](#attachments) | object | Files attached to tickets or forum posts in Zendesk. |
54+
| [organizations](#organizations) | object | Groups of end users (customers) segmented for support management. |
55+
| [ticket_events](#ticket_events) | events | Stream of ticket updates showing all field changes per event. Segment pulls one year of ticket events by default. To load older data, contact [Segment Support](https://segment.com/help/contact/){:target="_blank"}. |
56+
| [ticket_metrics](#ticket_metrics) | object | Aggregate performance metrics for tickets, such as reply and resolution times. |
57+
| [satisfaction_ratings](#satisfaction_ratings) | object | Customer satisfaction ratings submitted for resolved tickets. |
58+
| [ticket_comments](#ticket_comments) | object | Ticket comments exchanged between requesters, collaborators, and agents, including both public and private comments. This collection isn’t included by default but can be turned on by contacting [Segment Support](https://segment.com/help/contact/){:target="_blank"}. |
59+
| [ticket_forms](#ticket_forms) | object | Ticket forms define subsets of fields shown to agents and end users. This collection requires a Zendesk Enterprise account. |
60+
| [ticket_skips](#ticket_skips) | object | Records of tickets skipped by agents. Segment fully syncs all available records during each sync run. |
61+
| [organization_memberships](#organization_memberships) | object | Links users to organizations. Organizations can have many users, and users can belong to multiple organizations if supported. Segment fully syncs all available records during each sync run. |
62+
| [group_memberships](#group_memberships) | object | Links agents to groups. Groups can have many agents, and agents can belong to multiple groups. Segment fully syncs all available records during each sync run. |
63+
| [audit_logs](#audit_logs) | object | Records account-level configuration and user actions. This collection isn’t included by default but can be turned on by contacting [Segment Support](https://segment.com/help/contact/){:target="_blank"}. |
6864

6965
In your warehouse, each collection is stored in its own table. The tables that follow list the standard properties Segment automatically fetches for each collection.
7066

@@ -107,7 +103,7 @@ This collection contains information about Zendesk users.
107103
| `active` | Set to `false` if the user has been deleted. |
108104
| `shared` | Indicates whether the user is a shared agent from another Zendesk instance (ticket sharing accounts only). |
109105
| `last_login_at` | The date and time of the user’s last login. |
110-
| `two_factor_auth_enabled` | Indicates whether two-factor authentication is enabled. |
106+
| `two_factor_auth_enabled` | Indicates whether two-factor authentication is turned on. |
111107
| `signature` | The user’s signature (agents and admins only). |
112108
| `details` | Additional details about the user, such as an address. |
113109
| `notes` | Notes stored about the user. |

0 commit comments

Comments
 (0)