Skip to content

Automatic translation — the Portuguese version is the reference. View in Portuguese

Updated on 2026-10-04

ClickUp — connector

Reads a list's tasks (status, assignees, priority, due dates) and the teams (workspaces) from ClickUp API v2 and loads them into the Bronze layer.

On this page (15)

Read first: ../conectores.md (state map) and fichas.md (index of cards).


What it is#

Reads a list's tasks (status, assignees, priority, due dates) and the teams (workspaces) from ClickUp API v2 and loads them into the Bronze layer.

Supported ingestion modes:

  • Nós buscamos — Nós buscamos os dados na sua fonte.

What it's for#

Bring ClickUp data into your datalake and make it available to the Bronze/Silver/Gold layers, BI models and the natural-language question wizard.

When to use / when not to use#

Use when you need to consolidate this source into the datalake on a scheduled basis, with isolation by workspace.

Remember that the first run with a real credential is followed by our team before the connector is fully released.

Plan and permissions#

  • Plan: core product (connectors are part of all plans; the limit is the number of sources in the plan).
  • Access: requires an active workspace — with the subscription overdue, suspended or canceled, the run is blocked.
  • Shutdown: the ingestion run can be temporarily turned off (maintenance or incident). When that happens, the screen indicates the resource is unavailable at the moment.

Prerequisites#

  • A ClickUp account with access to the data you want to ingest.
  • In ClickUp, go to Settings → Apps → API Token and generate your personal token (starts with pk_). Provide the list ID (in the URL: app.clickup.com/<time>/v/li/<ID>) and paste the token — it is encrypted and never shown again.

Credentials#

Authentication method: API key generated in the provider panel, sent in header/parameter.

Sensitive fields. They are encrypted (AES-256-GCM) and are never placed in the connection config, pipeline definition, export or DAG. By default the encrypted value is stored in the database; moving the credential from this connection to an external credential vault is an explicit choice made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.

  • Personal API token (tokenApi) — Generated in Settings → Apps → API Token. Goes in the Authorization header, without prefix.

Secrets are never re-displayed and are redacted in any error/log (raw token, URL-encoded and in JSON).

Form fields#

CampoRótuloTipoObrigatórioObservação
listIdID da listatextosimNúmero da lista na URL do ClickUp (…/v/li/<ID>) ou em Configurações da lista → Copiar ID.
tokenApi 🔒Token pessoal da APIsenha/segredosimsegredo (cifrado; cofre externo opcional); Gerado em Configurações → Apps → API Token. Vai no header Authorization, sem prefixo.

Step by step#

  1. In the Dados → Conexões menu, use Nova conexão.
  2. Choose ClickUp in the catalog.
  3. Fill the form fields (see the table above).
  4. Use Testar conexão. The result is shown broken down into Conectividade, Autenticação and Listagem/leitura — each with OK, Failed, Not applicable or Not tested. A capability with no test of its own for this connector shows as Not applicable, and Not applicable never counts as success.
  5. Use Salvar conexão. Saving DOES NOT start any ingestion.
  6. On the connection card, use Montar extração (or go to Orquestração → Pipelines and use Conectar fonte). The pipeline points to the saved connection — the credential is not copied.
  7. In the review, Publicar (agenda desligada) creates version 1 without running anything. Then, Ativar agenda and Executar agora are separate actions.

Example — connection test#

Sample configuration (all values fictitious; secrets appear masked):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
listId = <listId>
tokenApi = •••••• (cifrado — nunca exibido)

Expected result#

The Testar conexão returns the list of discovered tables/resources. After the first load, rows appear in the Bronze layer of your workspace, ready for the pipeline.

Limits and costs#

  • Pagination: hard limit per run (default 10,000 pages / 5,000,000 rows); anti-loop guard.
  • SaaS load: default batchSize 5,000, maxRows 200,000 per resource.
  • Estimated volume: ~0.2 GB/month (catalog estimate, not a measurement).
  • Cost: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).

Security#

  • Scope by workspace: each customer reads and writes only to their own datalake (<prefix>_bronze / _silver / _gold); there is never leakage between workspaces.
  • Encrypted secrets: sensitive material is encrypted with AES-256-GCM before being written. External credential vault is optional and enabled per connection; without it, the encrypted value is stored in the database. Changing the value here DOES NOT revoke the credential at the source.
  • Redaction: all error/log output undergoes secret redaction (raw, URL-encoded and in JSON).
  • Production does not fake: a path that would fall into a mock triggers the production guard (explicit failure instead of simulating success).

Common errors#

  • Credential rejected (401/403) — the provider did not accept the credential: expired, revoked or lacking necessary permissions. Reconnect the source (the source and history are preserved; do not recreate the source).
  • Rate limit (429) — the provider asked to wait. The extraction respects Retry-After and retries; if it repeats, wait and reduce the schedule frequency.
  • Resource not found — check the resource identifier (account, object, report) and the granted permissions.
  • Stuck pagination cursor — the extraction stops when the API cursor does not advance (anti-loop guard). If it happens on repeated runs, open a support ticket specifying the connector and the resource.
  • Empty record path — the response arrived without records in the expected place. Check the selected resource and filters (period, account, status) before assuming there is no data.

Troubleshooting#

  • Use Testar conexão to isolate credential/network problems before scheduling.
  • Monitor runs in the connector observability (error rate, p50/p95, freshness).
  • A schema change at the source is signaled by schema drift (new column = info; removed column/type changed = attention).

Related#


Last revision: 2026-10-04. Card automatically generated from the product's connector catalog.

Related links