07af2ff4bf
* feat(connectors): add source clickup api template
* feat(connectors/clickup-api): add /user and /team endpoint configs
* docs(clickup-connectors): add clickup source doc
* feat: add tasks stream and list stream to ClickUp API
* feat: add space stream and folder stream to clikcup api
* feat: update acceptance-test-config.yml w/ version in 0.2.12
459856b73c/airbyte-integrations/bases/source-acceptance-test (migrating-acceptance-test-configyml-to-latest-configuration-format)
* docs: add descripiton for optional configs fields
* fix: fix list.json schema
* fix: add ignore_fields to ignore changing value in full_refresh of acceptance-tests
* add clickup to source def
* auto-bump connector version
Co-authored-by: marcosmarxm <marcosmarxm@gmail.com>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
57 lines
2.4 KiB
Markdown
57 lines
2.4 KiB
Markdown
# ClickUp API
|
|
|
|
## Sync overview
|
|
|
|
This source can sync data from [ClickUp API](https://clickup.com/api/). Currently, this connector only supports full refresh syncs. That is, every time a sync is run, all the records are fetched from the source.
|
|
|
|
|
|
### Output schema
|
|
|
|
This source is capable of syncing the following streams:
|
|
|
|
* [`user`](https://clickup.com/api/clickupreference/operation/GetAuthorizedUser/)
|
|
* [`teams`](https://clickup.com/api/clickupreference/operation/GetAuthorizedTeams/)
|
|
* [`spaces`](https://clickup.com/api/clickupreference/operation/GetSpaces/)
|
|
* [`folders`](https://clickup.com/api/clickupreference/operation/GetFolders/)
|
|
* [`lists`](https://clickup.com/api/clickupreference/operation/GetLists/)
|
|
* [`tasks`](https://clickup.com/api/clickupreference/operation/GetTasks)
|
|
|
|
|
|
### Features
|
|
|
|
| Feature | Supported? \(Yes/No\) | Notes |
|
|
|:------------------|:----------------------|:--------------------------------------------------------|
|
|
| Full Refresh Sync | Yes | |
|
|
| Incremental Sync | No | |
|
|
|
|
### Performance considerations
|
|
|
|
The ClickUp API enforces request rate limits per token. The rate limits are depending on your workplace plan. See [here](https://clickup.com/api/developer-portal/rate-limits/).
|
|
|
|
## Getting started
|
|
|
|
### Requirements
|
|
|
|
1. Generate an API key from [ClickUp](https://clickup.com/). See [here](https://clickup.com/api/developer-portal/authentication/#generate-your-personal-api-token).
|
|
|
|
### Setup guide
|
|
|
|
The following fields are required fields for the connector to work:
|
|
|
|
* `api_token`: Your ClickUp API Token.
|
|
|
|
Here are some optional fields for different streams:
|
|
|
|
* `team_id`: Your team ID in your ClickUp workspace. It is required for `space` stream.
|
|
|
|
* `space_id`: Your space ID in your ClickUp workspace. It is required for `folder` stream.
|
|
|
|
* `folder_id`: Your folder ID in your ClickUp space. It is required for `list` stream.
|
|
|
|
* `list_id`: Your list ID in your folder of space. It is required for `task` stream.
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
|:--------|:-----------|:---------------------------------------------------------|:-----------|
|
|
| 0.1.0 | 2022-11-07 | [17770](https://github.com/airbytehq/airbyte/pull/17770) | New source | |