2906ec287a
* Add action to check broken doc links * Ignore localhost * Update config * Fix broken links * Use quiet mode * Ignore PR link * Fix more broken links * Fix more broken links * Fix more broken links * Verify pattern * Fix more broken links * Separate full and pr check * Update pattern * Test invalid link * Remove invalid link
5.2 KiB
Zendesk Support
Sync overview
The Zendesk Support source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.
This source can sync data for the Zendesk Support API. This Source Connector is based on a Airbyte CDK. Incremental sync are implemented on API side by its filters
Output schema
This Source is capable of syncing the following core Streams:
- Tickets
- Groups
- Users
- Organizations
- Ticket Audits
- Ticket Comments
- Ticket Fields
- Ticket Forms
- Ticket Metrics
- Group Memberships
- Macros
- Satisfaction Ratings
- Tags
- SLA Policies
Not implemented schema
These Zendesk endpoints are available too. But syncing with them will be implemented in the future.
Tickets
Help Center
- Articles
- Article Attachments
- Article Comments
- Categories
- Management Permission Groups
- Translations
- Sections
- Topics
- Themes
- Posts
- Themes
- Post Comments
Data type mapping
| Integration Type | Airbyte Type | Notes |
|---|---|---|
string |
string |
|
number |
number |
|
array |
array |
|
object |
object |
Features
| Feature | Supported?(Yes/No) | Notes |
|---|---|---|
| Full Refresh Sync | Yes | |
| Incremental - Append Sync | Yes | |
| Incremental - Debuped + History Sync | Yes | Enabled according to type of destination |
| Namespaces | No |
Performance considerations
The connector is restricted by normal Zendesk requests limitation.
The Zendesk connector should not run into Zendesk API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.
Getting started
Requirements
- Zendesk Subdomain
- Auth Method
- API Token
- Zendesk API Token
- Zendesk Email
- oAuth2 (not implemented)
- API Token
Setup guide
Generate a API access token using the Zendesk support
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.
CHANGELOG
| Version | Date | Pull Request | Subject |
|---|---|---|---|
0.1.0 |
2021-07-21 | 4861 | created CDK native zendesk connector |