Skip to content

Commit 9ebea7b

Browse files
author
Oleksandr Bazarnov
committed
updated docs
1 parent d1d50ed commit 9ebea7b

File tree

1 file changed

+12
-39
lines changed

1 file changed

+12
-39
lines changed

docs/integrations/sources/zendesk-support.md

Lines changed: 12 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -29,30 +29,6 @@ This Source is capable of syncing the following core Streams:
2929
* [Ticket Metric Events](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metric_events/)
3030
* [Users](https://developer.zendesk.com/rest_api/docs/support/users)
3131

32-
The streams below are not implemented. Please open a Github issue or request it through Airbyte Cloud's support box if you are interested in them.
33-
34-
**Tickets**
35-
36-
* [Ticket Attachments](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/)
37-
* [Ticket Requests](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-requests/)
38-
* [Ticket Activities](https://developer.zendesk.com/api-reference/ticketing/tickets/activity_stream/)
39-
* [Ticket Skips](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_skips/)
40-
41-
**Help Center**
42-
43-
* [Articles](https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/)
44-
* [Article Attachments](https://developer.zendesk.com/api-reference/help_center/help-center-api/article_attachments/)
45-
* [Article Comments](https://developer.zendesk.com/api-reference/help_center/help-center-api/article_comments/)
46-
* [Categories](https://developer.zendesk.com/api-reference/help_center/help-center-api/categories/)
47-
* [Management Permission Groups](https://developer.zendesk.com/api-reference/help_center/help-center-api/permission_groups/)
48-
* [Translations](https://developer.zendesk.com/api-reference/help_center/help-center-api/translations/)
49-
* [Sections](https://developer.zendesk.com/api-reference/help_center/help-center-api/sections/)
50-
* [Topics](https://developer.zendesk.com/api-reference/help_center/help-center-api/topics)
51-
* [Themes](https://developer.zendesk.com/api-reference/help_center/help-center-api/theming)
52-
* [Posts](https://developer.zendesk.com/api-reference/help_center/help-center-api/posts)
53-
* [Themes](https://developer.zendesk.com/api-reference/help_center/help-center-api/posts)
54-
* [Post Comments](https://developer.zendesk.com/api-reference/help_center/help-center-api/post_comments/)
55-
5632
### Data type mapping
5733

5834
| Integration Type | Airbyte Type |
@@ -78,30 +54,27 @@ The connector is restricted by normal Zendesk [requests limitation](https://deve
7854
The Zendesk connector should not run into Zendesk API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
7955

8056
## Getting started
57+
1. Click `Authenticate your Zendesk account`
58+
2. Enter a `Start Date` as the minimum date of your data replication.
59+
3. Enter your `Subdomain`. Learn how to find it in the `Requirements` section.
60+
4. Click on `Setup Source`.
61+
5. You're now ready to sync your data.
8162

8263
### Requirements
8364

84-
* Zendesk Subdomain
85-
* Auth Method
86-
* API Token
87-
* Zendesk API Token
88-
* Zendesk Email
89-
* OAuth2.0 (obtain access_token by authorising your Zendesk Account)
90-
91-
### Setup guide
92-
93-
* API Token
94-
Generate a API access token using the [Zendesk support](https://support.zendesk.com/hc/en-us/articles/226022787-Generating-a-new-API-token)
95-
96-
We recommend creating a restricted, read-only key specifically for Airbyte access. This will allow you to control which resources Airbyte should be able to access.
65+
* `Subdomain` - this is your Zendesk subdomain that can be found in your account URL. For example, in `https://{MY_SUBDOMAIN}.zendesk.com/`, where `MY_SUBDOMAIN` is the value of your subdomain.
66+
* `Authentication` - Zendesk service provides two authentication methods. Choose between: `OAuth2.0` or `API token`.
67+
* Authentication using `OAuth2.0` (Only for Airbyte Cloud) - obtain `access_token` by authorising using your Zendesk Account credentials. Simply proceed by pressing "Authenticate your Zendesk Account" and complete the authentication.
68+
* Authentication using `API Token`:
69+
* `API Token` - the value of the API token generated. See the [generating API Token](https://support.zendesk.com/hc/en-us/articles/226022787-Generating-a-new-API-token) for more information.
70+
* `Email` - the user email for your Zendesk account.
9771

98-
* OAuth2.0 (Only for Airbyte Cloud)
99-
Simply proceed by pressing "Authenticate your Account" and complete the authentication with your Zendesk credentials.
10072

10173
### CHANGELOG
10274

10375
| Version | Date | Pull Request | Subject |
10476
|:---------|:-----------| :----- |:-------------------------------------------------------|
77+
| `0.2.4` | 2022-04-04 | [11688](https://github.com/airbytehq/airbyte/pull/11688) | Small documentation corrections
10578
| `0.2.3` | 2022-03-23 | [11349](https://github.com/airbytehq/airbyte/pull/11349) | Fixed the bug when Tickets stream didn't return deleted records
10679
| `0.2.2` | 2022-03-17 | [11237](https://github.com/airbytehq/airbyte/pull/11237) | Fixed the bug when TicketComments stream didn't return all records
10780
| `0.2.1` | 2022-03-15 | [11162](https://github.com/airbytehq/airbyte/pull/11162) | Added support of OAuth2.0 authentication method

0 commit comments

Comments
 (0)