Skip to content

Commit f74634f

Browse files
Apply suggestions from code review [netlify-build]
Co-authored-by: stayseesong <[email protected]>
1 parent f745d9a commit f74634f

File tree

1 file changed

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

1 file changed

+26
-26
lines changed

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

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ id: 3hbak7a9
99

1010
## Getting Started
1111

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.
1313

14-
2. Choose Zendesk.
14+
2. Search for **Zendesk** in the Sources Catalog and click **Add Source**.
1515

1616
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`.
1717

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.
1919

2020
4. Enter your Zendesk subdomain. The subdomain you use to access your Zendesk portal (for example 'segment' for segment.zendesk.com)
2121

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.
2323

2424
5. Click **Authorize** to start Zendesk's OAuth process. Sign in and grant permissions, you'll be good to go.
2525

@@ -29,17 +29,17 @@ id: 3hbak7a9
2929

3030
### Rate Limits
3131

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.
3333

3434
## Components
3535

3636
### Sync
3737

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`).
3939

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`.
4141

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.
4343

4444
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/).
4545

@@ -589,27 +589,27 @@ In your warehouse, each collection gets its own table. Find below a list of the
589589
</tr>
590590
<tr>
591591
<td>ticket_id</td>
592-
<td> ID of the associated ticket.</td>
592+
<td> The ID of the associated ticket.</td>
593593
</tr>
594594
<tr>
595595
<td>timestamp</td>
596-
<td> Time when the ticket was updated.</td>
596+
<td> The time when the ticket was updated.</td>
597597
</tr>
598598
<tr>
599599
<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>
601601
</tr>
602602
<tr>
603603
<td>ticket_event_via</td>
604604
<td> How the event was created.</td>
605605
</tr>
606606
<tr>
607607
<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>
609609
</tr>
610610
<tr>
611611
<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>
613613
</tr>
614614
<tr>
615615
<td>context_latitude</td>
@@ -717,7 +717,7 @@ In your warehouse, each collection gets its own table. Find below a list of the
717717
</tr>
718718
<tr>
719719
<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>
721721
</tr>
722722
<tr>
723723
<td>notes</td>
@@ -861,19 +861,19 @@ In your warehouse, each collection gets its own table. Find below a list of the
861861
</tr>
862862
<tr>
863863
<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>
865865
</tr>
866866
<tr>
867867
<td>name</td>
868868
<td>The name of the form.</td>
869869
</tr>
870870
<tr>
871871
<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>
873873
</tr>
874874
<tr>
875875
<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>
877877
</tr>
878878
<tr>
879879
<td>updated_at</td>
@@ -889,11 +889,11 @@ In your warehouse, each collection gets its own table. Find below a list of the
889889
</tr>
890890
<tr>
891891
<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>
893893
</tr>
894894
<tr>
895895
<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>
897897
</tr>
898898
<tr>
899899
<td>position</td>
@@ -909,7 +909,7 @@ In your warehouse, each collection gets its own table. Find below a list of the
909909
</tr>
910910
<tr>
911911
<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>
913913
</tr>
914914
</table>
915915

@@ -925,19 +925,19 @@ In your warehouse, each collection gets its own table. Find below a list of the
925925
</tr>
926926
<tr>
927927
<td>user_id</td>
928-
<td>ID of the skipping agent.</td>
928+
<td>The ID of the skipping agent.</td>
929929
</tr>
930930
<tr>
931931
<td>reason</td>
932-
<td>Reason for skipping the ticket.</td>
932+
<td>The reason for skipping the ticket.</td>
933933
</tr>
934934
<tr>
935935
<td>created_at</td>
936-
<td>Time the skip was created.</td>
936+
<td>The time the skip was created.</td>
937937
</tr>
938938
<tr>
939939
<td>updated_at</td>
940-
<td>Time the skip was last updated.</td>
940+
<td>The time the skip was last updated.</td>
941941
</tr>
942942
</table>
943943

@@ -949,7 +949,7 @@ In your warehouse, each collection gets its own table. Find below a list of the
949949
</tr>
950950
<tr>
951951
<td>id</td>
952-
<td>Automatically assigned when creating groups. </td>
952+
<td>This is automatically assigned when creating groups. </td>
953953
</tr>
954954
<tr>
955955
<td>url</td>
@@ -961,7 +961,7 @@ In your warehouse, each collection gets its own table. Find below a list of the
961961
</tr>
962962
<tr>
963963
<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>
965965
</tr>
966966
<tr>
967967
<td>created_at</td>

0 commit comments

Comments
 (0)