15950dfdb2
* setting a timeout in client side * upgraded version * upgraded pendulum lib * fix spec like docs * chore: bump version in source definitions * chore: update seed file Co-authored-by: Harshith Mullapudi <harshithmullapudi@gmail.com>
4.1 KiB
4.1 KiB
Zendesk Chat
Sync overview
The Zendesk Chat source supports Full Refresh and Incremental syncs.
This source can sync data for the Zendesk Chat API.
Output schema
This Source is capable of syncing the following core Streams:
- Accounts
- Agents (Incremental)
- Agent Timelines (Incremental)
- Chats
- Shortcuts
- Triggers
- Bans (Incremental)
- Departments
- Goals
- Skills
- Roles
- Routing Settings
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 Sync | Yes | |
| SSL connection | Yes |
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 Chat Access Token
Connect using OAuth 2.0 option:
- Select
OAuth2.0inAuthorization Method - Click on
authenticate your Zendesk Chat account - Proceed the authentication using your credentials for your Zendesk account.
Connect using Access Token option:
- Generate a Access Token as described in Zendesk Chat docs
- Use the generated
access_tokenin Airbyte connection.
Setup guide
Generate a Access Token as described in Zendesk Chat docs
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.7 | 2022-05-25 | 12883 | Passing timeout in request to prevent a stuck connection |
| 0.1.6 | 2021-12-15 | 7313 | Added support of OAuth 2.0 authentication. 8819 Fixed the issue with created_at can now be null for bans stream |
| 0.1.5 | 2021-12-06 | 8425 | Update title, description fields in spec |
| 0.1.4 | 2021-11-22 | 8166 | Make Chats stream incremental + add tests for all streams |
| 0.1.3 | 2021-10-21 | 7210 | Chats stream is only getting data from first page |
| 0.1.2 | 2021-08-17 | 5476 | Correct field unread to boolean type |
| 0.1.1 | 2021-06-09 | 3973 | Add AIRBYTE_ENTRYPOINT for Kubernetes support |
| 0.1.0 | 2021-05-03 | 3088 | Initial release |