You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/sources/catalog/cloud-apps/zendesk/index.md
+26-26Lines changed: 26 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,17 +9,17 @@ id: 3hbak7a9
9
9
10
10
## Getting Started
11
11
12
-
1.From your workspace's `sources` page, click `add source`.
12
+
1.Go to **Connections > Sources** and click **Add Source** in the Segment app.
13
13
14
-
2.Choose Zendesk.
14
+
2.Search for **Zendesk** in the Sources Catalog and click **Add Source**.
15
15
16
16
3. Give the Source a name and add any labels to help you organize and filter your sources. You can give the source any name, but Segment recommends a name that reflects the source itself, as this name auto-populates the schema name. For example, the source name `Zendesk` creates the schema `zendesk`.
17
17
18
-
**Note**: You can add multiple instances if you have multiple Zendesk accounts. That's why Segment allows you to customize the source's nickname and schema name.
18
+
***Note**: You can add multiple instances if you have multiple Zendesk accounts. That's why Segment allows you to customize the source's nickname and schema name.
19
19
20
20
4. Enter your Zendesk subdomain. The subdomain you use to access your Zendesk portal (for example 'segment' for segment.zendesk.com)
21
21
22
-
**Note** If you enter `segment.zendesk.com` as a subdomain instead of just `segment`, Segment tries to access the host `segment.zendesk.com.zendesk.com` and you will get a credentials error.
22
+
***Note:** If you enter `segment.zendesk.com` as a subdomain instead of just `segment`, Segment tries to access the host `segment.zendesk.com.zendesk.com` and you will get a credentials error.
23
23
24
24
5. Click **Authorize** to start Zendesk's OAuth process. Sign in and grant permissions, you'll be good to go.
25
25
@@ -29,17 +29,17 @@ id: 3hbak7a9
29
29
30
30
### Rate Limits
31
31
32
-
The Zendesk source uses both Zendesk's [Core API](https://developer.zendesk.com/api-reference/) and [Incremental Exports API](https://developer.zendesk.com/rest_api/docs/core/incremental_export). The source's requests to the Incremental API do not count towards your Zendesk account's rate limits, but requests to the Core API do. By default, Segment caps requests to Zendesk's Core API to a rate of 200 requests per minute to avoid triggering [Zendesk's Rate Limits](https://developer.zendesk.com/api-reference/ticketing/account-configuration/usage_limits/). If you'd like to increase or decrease the request rate for your source, [please reach out](https://segment.com/help/contact/). Support for this in the UI is in the works.
32
+
The Zendesk source uses both Zendesk's [Core API](https://developer.zendesk.com/api-reference/){:target="_blank"} and [Incremental Exports API](https://developer.zendesk.com/rest_api/docs/core/incremental_export){:target="_blank"}. The source's requests to the Incremental API don't count towards your Zendesk account's rate limits, but requests to the Core API do. By default, Segment caps requests to Zendesk's Core API to a rate of 200 requests per minute to avoid triggering [Zendesk's Rate Limits](https://developer.zendesk.com/api-reference/ticketing/account-configuration/usage_limits/){:target="_blank"}. If you'd like to increase or decrease the request rate for your source, [please reach out](https://segment.com/help/contact/). Support for this in the UI is in the works.
33
33
34
34
## Components
35
35
36
36
### Sync
37
37
38
-
The Zendesk source is built with a sync component, which means Segment makes requests to their API on your behalf on a three hour interval to pull the latest data into Segment. In the initial sync, Segment grabs all the Zendesk objects (and their corresponding properties) according to the Collections Table below. The objects will be written into a separate schema, corresponding to the source instance's schema name you designated upon creation (like `zendesk_prod.users`).
38
+
The Zendesk source is built with a sync component, which means Segment makes requests to their API on your behalf on a three hour interval to pull the latest data into Segment. In the initial sync, Segment grabs all the Zendesk objects (and their corresponding properties) according to the Collections Table below. The objects are written into a separate schema, corresponding to the source instance's schema name you designated upon creation (like `zendesk_prod.users`).
39
39
40
-
The sync component uses an upsert API, so the data in your warehouse loaded using sync will reflect the latest state of the corresponding resource in Zendesk. For example, if `ticket_status` goes from `open` to `closed` between syncs, on its next sync that tickets status will be`closed`.
40
+
The sync component uses an upsert API, so the data in your warehouse loaded using sync reflects the latest state of the corresponding resource in Zendesk. For example, if `ticket_status` goes from `open` to `closed` between syncs, on its next sync that tickets status is`closed`.
41
41
42
-
The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment every three hours. Depending on your Warehouses plan, Segment pushes the Source data to your warehouse on the interval associated with your billing plan.
42
+
The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources sync with Segment every three hours. Depending on your Warehouses plan, Segment pushes the Source data to your warehouse on the interval associated with your billing plan.
43
43
44
44
At the moment, Segment doesn't support filtering which objects or properties get synced. If you're interested in this feature, [please reach out](https://segment.com/help/contact/).
45
45
@@ -589,27 +589,27 @@ In your warehouse, each collection gets its own table. Find below a list of the
589
589
</tr>
590
590
<tr>
591
591
<td>ticket_id</td>
592
-
<td> ID of the associated ticket.</td>
592
+
<td> The ID of the associated ticket.</td>
593
593
</tr>
594
594
<tr>
595
595
<td>timestamp</td>
596
-
<td> Time when the ticket was updated.</td>
596
+
<td> The time when the ticket was updated.</td>
597
597
</tr>
598
598
<tr>
599
599
<td>updater_id</td>
600
-
<td> ID of the user who updated the ticket.</td>
600
+
<td> The ID of the user who updated the ticket.</td>
601
601
</tr>
602
602
<tr>
603
603
<td>ticket_event_via</td>
604
604
<td> How the event was created.</td>
605
605
</tr>
606
606
<tr>
607
607
<td>context_client</td>
608
-
<td> Refers to the "client" used to submit this ticket change (for example, browser name and type).</td>
608
+
<td> This refers to the "client" used to submit this ticket change (for example, browser name and type).</td>
609
609
</tr>
610
610
<tr>
611
611
<td>context_location</td>
612
-
<td> Plain text name of where the request was made, if available (for example, country, city).</td>
612
+
<td> The plain text name of where the request was made, if available (for example, country, city).</td>
613
613
</tr>
614
614
<tr>
615
615
<td>context_latitude</td>
@@ -717,7 +717,7 @@ In your warehouse, each collection gets its own table. Find below a list of the
717
717
</tr>
718
718
<tr>
719
719
<td>details</td>
720
-
<td> Any details about the organization, such as the address.</td>
720
+
<td> This includes any details about the organization, such as the address.</td>
721
721
</tr>
722
722
<tr>
723
723
<td>notes</td>
@@ -861,19 +861,19 @@ In your warehouse, each collection gets its own table. Find below a list of the
861
861
</tr>
862
862
<tr>
863
863
<td>end_user_visible</td>
864
-
<td>Shows if the form is visible to the end user.</td>
864
+
<td>This shows if the form is visible to the end user.</td>
865
865
</tr>
866
866
<tr>
867
867
<td>name</td>
868
868
<td>The name of the form.</td>
869
869
</tr>
870
870
<tr>
871
871
<td>restricted_brand_ids</td>
872
-
<td>IDs of all brands that this ticket form is restricted to.</td>
872
+
<td>The IDs of all brands that this ticket form is restricted to.</td>
873
873
</tr>
874
874
<tr>
875
875
<td>ticket_field_ids</td>
876
-
<td>IDs of all ticket fields which are in this ticket form.</td>
876
+
<td>The IDs of all ticket fields which are in this ticket form.</td>
877
877
</tr>
878
878
<tr>
879
879
<td>updated_at</td>
@@ -889,11 +889,11 @@ In your warehouse, each collection gets its own table. Find below a list of the
889
889
</tr>
890
890
<tr>
891
891
<td>display_name</td>
892
-
<td>The name of the form that is displayed to the end user.</td>
892
+
<td>The name of the form that displays to the end user.</td>
893
893
</tr>
894
894
<tr>
895
895
<td>in_all_brands</td>
896
-
<td>Shows if the form is available for use in all brands on this account.</td>
896
+
<td>This shows if the form is available for use in all brands on this account.</td>
897
897
</tr>
898
898
<tr>
899
899
<td>position</td>
@@ -909,7 +909,7 @@ In your warehouse, each collection gets its own table. Find below a list of the
909
909
</tr>
910
910
<tr>
911
911
<td>default</td>
912
-
<td>Shows if this form is the default form for this account.</td>
912
+
<td>This shows if this form is the default form for this account.</td>
913
913
</tr>
914
914
</table>
915
915
@@ -925,19 +925,19 @@ In your warehouse, each collection gets its own table. Find below a list of the
925
925
</tr>
926
926
<tr>
927
927
<td>user_id</td>
928
-
<td>ID of the skipping agent.</td>
928
+
<td>The ID of the skipping agent.</td>
929
929
</tr>
930
930
<tr>
931
931
<td>reason</td>
932
-
<td>Reason for skipping the ticket.</td>
932
+
<td>The reason for skipping the ticket.</td>
933
933
</tr>
934
934
<tr>
935
935
<td>created_at</td>
936
-
<td>Time the skip was created.</td>
936
+
<td>The time the skip was created.</td>
937
937
</tr>
938
938
<tr>
939
939
<td>updated_at</td>
940
-
<td>Time the skip was last updated.</td>
940
+
<td>The time the skip was last updated.</td>
941
941
</tr>
942
942
</table>
943
943
@@ -949,7 +949,7 @@ In your warehouse, each collection gets its own table. Find below a list of the
949
949
</tr>
950
950
<tr>
951
951
<td>id</td>
952
-
<td>Automatically assigned when creating groups. </td>
952
+
<td>This is automatically assigned when creating groups. </td>
953
953
</tr>
954
954
<tr>
955
955
<td>url</td>
@@ -961,7 +961,7 @@ In your warehouse, each collection gets its own table. Find below a list of the
961
961
</tr>
962
962
<tr>
963
963
<td>organization_id</td>
964
-
<td>the ID of the organization associated with this user.</td>
964
+
<td>The ID of the organization associated with this user.</td>
0 commit comments