Skip to content

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

Updated on 2026-10-04

Jira — connector

Reads issues (with status, assignee, priority and dates), projects and users from the Jira Cloud REST API v3 and loads them into the Bronze layer.

On this page (15)

Leia antes: ../conectores.md (mapa de estados) e fichas.md (índice das fichas).


What it is#

Reads issues (with status, assignee, priority and dates), projects and users from the Jira Cloud REST API v3 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 Jira data into your datalake and make it available to the Bronze/Silver/Gold layers, BI models and the natural language questions 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 per 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 allowed by 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 disabled (maintenance or incident). When this happens, the screen indicates the feature is unavailable at the moment.

Prerequisites#

  • A Jira account with access to the data you want to ingest.
  • In Atlassian (id.atlassian.com → Security → API tokens) create an API token for your user. Provide the Jira site URL, the account email and paste the token — it is encrypted (AES-256-GCM) and never shown again. We only read what that user already sees.

Credentials#

Authentication method: Username and password (or key and secret) using Basic authentication.

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

  • API token (tokenApi) — Generated in id.atlassian.com → Security → API tokens.

Secrets are never re-displayed and go through redaction in every error/log (raw token, URL-encoded and in JSON).

Form fields#

CampoRótuloTipoObrigatórioObservação
urlSiteURL do site JiratextosimO endereço do seu Jira Cloud (sem /jira no final).
emailE-mail da conta AtlassiantextosimE-mail do usuário que gerou o token de API.
tokenApi 🔒Token de APIsenha/segredosimsegredo (cifrado; cofre externo opcional); Gerado em id.atlassian.com → Segurança → Tokens de API.
jqlFiltro JQL das issuestextonãopadrão: order by updated DESC; Quais issues entram na tabela. Vazio traz tudo que o usuário enxerga, da mais recente para a mais antiga.

Step-by-step#

  1. No menu Dados → Conexões, use Nova conexão.
  2. Escolha Jira no catálogo.
  3. Preencha os campos do formulário (veja a tabela acima).
  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. Salvar NÃO inicia ingestão nenhuma.
  6. No cartão da conexão, use Montar extração (ou vá em Orquestração → Pipelines e use Conectar fonte). O pipeline aponta para a connection salva — a credential não é copiada.
  7. Na revisão, Publicar (agenda desligada) cria a versão 1 sem executar nada. Depois, Ativar agenda e Executar agora são ações separadas.

Example — connection test#

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

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
urlSite = <urlSite>
email = <email>
tokenApi = •••••• (cifrado — nunca exibido)
jql = order by updated DESC

Expected result#

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

Limits and costs#

  • Pagination: hard cap 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.3 GB/month (catalog estimate, not measurement).
  • Cost: the extraction itself is not charged by the platform; Bronze load consumes datalake processing (billable).

Security#

  • Scope by workspace: each customer reads and writes only to their own datalake (<prefixo>_bronze / _silver / _gold); there is never leakage between workspaces.
  • Encrypted secrets: sensitive material is encrypted with AES-256-GCM before being persisted. The external credential vault is optional and enabled per connection; without it, the encrypted value stays in the database. Changing the value here DOES NOT revoke the credential at the source.
  • Redaction: every error/log goes through secrets redaction (raw, URL-encoded and in JSON).
  • Production doesn't fake it: 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 permissions granted.
  • Pagination cursor stuck — the extraction stops when the API cursor does not advance (anti-loop guard). If it happens in consecutive runs, open a support ticket informing 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 connector observability (error rate, p50/p95, freshness).
  • A schema change at the source is signaled by schema drift (new column = info; column removed/type changed = attention).

Related#


Last review: 2026-10-04. Card automatically generated from the product connector catalog.

Related links