Package: tap-clickup
tap-clickuptap-clickupis a Singer tap for ClickUp.
Tap was created byAutoIDMonly because multiple community members came together to get this tap created. Check AutoIDM out for tap/target creation, maintenace, support, and more!SponsorsThis tap is only available due to the amazing folks who pitched together to make this happen.Note that some sponsors may not be listed here.Want to become a sponsor? Reach out to us atautoidm.comCapabilitiescatalogstatediscoveraboutstream-mapsschema-flatteningSettingsSettingRequiredDefaultDescriptionapi_tokenTrueNoneExample: 'pk_12345stream_mapsFalseNoneConfig object for stream maps capability.stream_map_configFalseNoneUser-defined config values to be used within map expressions.flattening_enabledFalseNone'True' to enable schema flattening and automatically expand nested properties.flattening_max_depthFalseNoneThe max depth to flatten schemas.A full list of supported settings and capabilities is available by running:tap-clickup --aboutGetting an API TokenLogin athttps://app.clickup.com/Click your icon at the bottom left of the screenClick My SettingsClick Apps (Bottom leftish of screen under the My Apps sub section)At the top of the screen is an API Token. This can be used in the api_token location.This is a personal token, it's fine to use a personal token as this tap is only for the business that's using the data.Clickup Table SchemasNote that the most up to date information is located in tap_clickup/streams.py. We will try to keep these docs updatedTeamsTable name: teamDescription: Teams Data, each user can be in multiple teamsPrimary key column(s):  idReplicated fully or incrementally: FullBookmark column(s): N/ALink to API endpoint documentation:TeamsSpacesTable name: spaceDescription: Each team has multiple spacesPrimary key column(s):  idReplicated fully or incrementally: FullBookmark column(s): N/ALink to API endpoint documentation:SpacesTime EntriesTable name: time_entriesDescription: All time entries are pulled for every team. Currently only pulls the last 30 days of time_entries seehttps://github.com/AutoIDM/tap-clickup/issues/134for an issue addressing this!Primary key column(s):  idReplicated fully or incrementally: FullBookmark column(s): N/ALink to API endpoint documentation:Time EntriesFoldersTable name: folderDescription: Each space can have multiple foldersPrimary key column(s):  idReplicated fully or incrementally: FullBookmark column(s): N/ALink to API endpoint documentation:FoldersFolder ListsTable name: folder_listDescription: Each Folder can have multiple listsPrimary key column(s):  idReplicated fully or incrementally: FullBookmark column(s): N/ALink to API endpoint documentation:Folder ListsFolderless ListsTable name: folderless_listDescription: Some lists do not exist in a folderPrimary key column(s):  idReplicated fully or incrementally: FullBookmark column(s): N/ALink to API endpoint documentation:Folderless ListsTask TemplatesTable name: task_templateDescription: Tasks can be templated for any reason you can imagine!Primary key column(s):  idReplicated fully or incrementally: FullBookmark column(s): updated_atLink to API endpoint documentation:Task TemplatesGoalsTable name: goalDescription: Teams can set goals for themselvesPrimary key column(s):  idReplicated fully or incrementally: FullBookmark column(s): N/ALink to API endpoint documentation:GoalsTagsTable name: tagDescription: Each space can have multiple tagsPrimary key column(s):  idReplicated fully or incrementally: FullBookmark column(s): N/ALink to API endpoint documentation:TagsShared HierarchyTable name: shared_hierarchyDescription: Returns all resources you have access to where you don't have access to its parent. For example, if you have a access to a shared task, but don't have access to its parent list, it will come back in this request.Primary key column(s): (No primary key column)Replicated fully or incrementally: FullBookmark column(s): N/ALink to API endpoint documentation:Shared HierarchyCustom Fields from Folderless ListsTable name: folderless_customfieldDescription: Each Folderless lists can have custom fields associated with themPrimary key column(s):  idReplicated fully or incrementally: FullBookmark column(s): N/ALink to API endpoint documentation:Custom FieldCustom Field from Folder ListsTable name: folder_customfieldDescription: Each Foldere list can have custom fields associated with themPrimary key column(s):  idReplicated fully or incrementally: FullBookmark column(s): N/ALink to API endpoint documentation:Custom FieldTasksTable name: tasksDescription: Some tasks do not sit under folders. This comes from the folderless_list endpointPrimary key column(s):  idReplicated fully or incrementally: IncrementalBookmark column(s): date_updated. Note that the api endpoint date_updated_gt is great than or equal to, not just greater than.Link to API endpoint documentation:Get TasksOther InfoDates are returned in UNIX timeAPI Limiting usesX-RateLimit headersInstallationpipxinstalltap-clickupUsageYou can easily runtap-clickupby itself or in a pipeline usingMeltano.Executing the Tap Directlytap-clickup--version
tap-clickup--help
tap-clickup--configCONFIG--discover>./catalog.jsonDeveloper ResourcesSchema DebuggingWe are waiting onhttps://gitlab.com/meltano/sdk/-/issues/299to get fixed as we make usage of refs in our json schema. Until then we parse the schemas in client.pySometimes it's useful to debug how the refs are being resolved. To do that there's a script inside of ./schema-parser , README in that directory describes how to run the parserNot worry about making this super fool proof as we expect the SDK to release some kind of fix for thisInitialize your Development Environmentpipxinstallpoetry
poetryinstallCreate and Run TestsCreate tests within thetap_clickup/testssubfolder and
then run:poetryrunpytestYou can also test thetap-clickupCLI interface directly usingpoetry run:poetryruntap-clickup--helpTesting withMeltano_Note:This tap will work in any Singer environment and does not require Meltano.Install Meltano (if you haven't already) and any needed plugins:# Install meltanopipxinstallmeltano# Initialize meltano within this directorycdtap-clickup
meltanoinstallNow you can test and orchestrate using Meltano:# Test invocation:meltanoinvoketap-clickup--version# OR run a test `elt` pipeline:meltanoelttap-clickuptarget-jsonlSDKBuilt with theMeltano SDKfor Singer Taps and Targets.