1
0
mirror of synced 2025-12-30 03:02:21 -05:00
Files
airbyte/docs/integrations/sources/click-up.md
Josix 07af2ff4bf 🎉 New Source: ClickUp (#17770)
* 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>
2022-11-13 17:41:23 -03:00

2.4 KiB

ClickUp API

Sync overview

This source can sync data from ClickUp 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:

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.

Getting started

Requirements

  1. Generate an API key from ClickUp. See here.

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 New source