Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📝 Source Zendesk Support: MLP documentation corrections #11688

Merged
merged 3 commits into from
Apr 5, 2022
Merged

📝 Source Zendesk Support: MLP documentation corrections #11688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1d50ed
corrected documentation up to mlp review
bazarnov Apr 4, 2022
9ebea7b
updated docs
bazarnov Apr 4, 2022
07a4a3a
new spec
bazarnov Apr 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion airbyte-config/init/src/main/resources/seed/source_definitions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,7 +843,7 @@
- name: Zendesk Support
sourceDefinitionId: 79c1aa37-dae3-42ae-b333-d1c105477715
dockerRepository: airbyte/source-zendesk-support
dockerImageTag: 0.2.3
dockerImageTag: 0.2.4
documentationUrl: https://docs.airbyte.io/integrations/sources/zendesk-support
icon: zendesk.svg
sourceType: api
Expand Down
13 changes: 7 additions & 6 deletions airbyte-config/init/src/main/resources/seed/source_specs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9001,7 +9001,7 @@
path_in_connector_config:
- "credentials"
- "client_secret"
- dockerImage: "airbyte/source-zendesk-support:0.2.3"
- dockerImage: "airbyte/source-zendesk-support:0.2.4"
spec:
documentationUrl: "https://docs.airbyte.io/integrations/sources/zendesk-support"
connectionSpecification:
Expand All @@ -9025,10 +9025,11 @@
subdomain:
type: "string"
title: "Subdomain"
description: "Identifier of your Zendesk Subdomain, like: https://{MY_SUBDOMAIN}.zendesk.com/,\
\ where MY_SUBDOMAIN is the value of your subdomain"
description: "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."
credentials:
title: "Authorization Method"
title: "Authentication *"
type: "object"
description: "Zendesk service provides two authentication methods. Choose\
\ between: `OAuth2.0` or `API token`."
Expand Down Expand Up @@ -9075,8 +9076,8 @@
title: "API Token"
type: "string"
description: "The value of the API token generated. See the <a href=\"\
https://docs.airbyte.io/integrations/sources/zendesk-support\">docs</a>\
\ for more information."
https://docs.airbyte.com/integrations/sources/zendesk-support#setup-guide\"\
>docs</a> for more information."
airbyte_secret: true
supportsNormalization: false
supportsDBT: false
Expand Down
2 changes: 1 addition & 1 deletion airbyte-integrations/connectors/source-zendesk-support/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ COPY source_zendesk_support ./source_zendesk_support
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]

LABEL io.airbyte.version=0.2.3
LABEL io.airbyte.version=0.2.4
LABEL io.airbyte.name=airbyte/source-zendesk-support
6 changes: 3 additions & 3 deletions airbyte-integrations/connectors/source-zendesk-support/source_zendesk_support/spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@
"subdomain": {
"type": "string",
"title": "Subdomain",
"description": "Identifier of your Zendesk Subdomain, like: https://{MY_SUBDOMAIN}.zendesk.com/, where MY_SUBDOMAIN is the value of your subdomain"
"description": "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."
},
"credentials": {
"title": "Authorization Method",
"title": "Authentication *",
"type": "object",
"description": "Zendesk service provides two authentication methods. Choose between: `OAuth2.0` or `API token`.",
"oneOf": [
Expand Down Expand Up @@ -66,7 +66,7 @@
"api_token": {
"title": "API Token",
"type": "string",
"description": "The value of the API token generated. See the <a href=\"https://docs.airbyte.io/integrations/sources/zendesk-support\">docs</a> for more information.",
"description": "The value of the API token generated. See the <a href=\"https://docs.airbyte.com/integrations/sources/zendesk-support#setup-guide\">docs</a> for more information.",
"airbyte_secret": true
}
}
Expand Down
51 changes: 12 additions & 39 deletions docs/integrations/sources/zendesk-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,30 +29,6 @@ This Source is capable of syncing the following core Streams:
* [Ticket Metric Events](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metric_events/)
* [Users](https://developer.zendesk.com/rest_api/docs/support/users)

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.

**Tickets**

* [Ticket Attachments](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/)
* [Ticket Requests](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-requests/)
* [Ticket Activities](https://developer.zendesk.com/api-reference/ticketing/tickets/activity_stream/)
* [Ticket Skips](https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_skips/)

**Help Center**

* [Articles](https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/)
* [Article Attachments](https://developer.zendesk.com/api-reference/help_center/help-center-api/article_attachments/)
* [Article Comments](https://developer.zendesk.com/api-reference/help_center/help-center-api/article_comments/)
* [Categories](https://developer.zendesk.com/api-reference/help_center/help-center-api/categories/)
* [Management Permission Groups](https://developer.zendesk.com/api-reference/help_center/help-center-api/permission_groups/)
* [Translations](https://developer.zendesk.com/api-reference/help_center/help-center-api/translations/)
* [Sections](https://developer.zendesk.com/api-reference/help_center/help-center-api/sections/)
* [Topics](https://developer.zendesk.com/api-reference/help_center/help-center-api/topics)
* [Themes](https://developer.zendesk.com/api-reference/help_center/help-center-api/theming)
* [Posts](https://developer.zendesk.com/api-reference/help_center/help-center-api/posts)
* [Themes](https://developer.zendesk.com/api-reference/help_center/help-center-api/posts)
* [Post Comments](https://developer.zendesk.com/api-reference/help_center/help-center-api/post_comments/)

### Data type mapping

| Integration Type | Airbyte Type |
Expand All @@ -78,30 +54,27 @@ The connector is restricted by normal Zendesk [requests limitation](https://deve
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.

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

### Requirements

* Zendesk Subdomain
* Auth Method
* API Token
* Zendesk API Token
* Zendesk Email
* OAuth2.0 (obtain access_token by authorising your Zendesk Account)

### Setup guide

* API Token
Generate a API access token using the [Zendesk support](https://support.zendesk.com/hc/en-us/articles/226022787-Generating-a-new-API-token)

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.
* `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.
* `Authentication` - Zendesk service provides two authentication methods. Choose between: `OAuth2.0` or `API token`.
* 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.
* Authentication using `API Token`:
* `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.
* `Email` - the user email for your Zendesk account.

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

### CHANGELOG

| Version | Date | Pull Request | Subject |
|:---------|:-----------| :----- |:-------------------------------------------------------|
| `0.2.4` | 2022-04-04 | [11688](https://github.com/airbytehq/airbyte/pull/11688) | Small documentation corrections
| `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
| `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
| `0.2.1` | 2022-03-15 | [11162](https://github.com/airbytehq/airbyte/pull/11162) | Added support of OAuth2.0 authentication method
Expand Down