Skip to content

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

Updated on 2026-10-04

Zendesk — connector

Reads tickets, users and organizations from the Zendesk Support v2 API and loads them into the Bronze layer.

On this page (15)

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


What it is#

Reads tickets, users and organizations from the Zendesk Support v2 API 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 Zendesk 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 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 turned off (maintenance or incident). When that happens, the screen indicates that the resource is unavailable at the moment.

Prerequisites#

  • A Zendesk account with access to the data you want to ingest.
  • In Zendesk, go to Admin Center → Apps and integrations → APIs → Zendesk API, enable token access and create an API token. Provide the account subdomain (acme, from acme.zendesk.com), the email of the agent who owns the token, and the token. The token is encrypted (AES-256-GCM) and is never shown again.

Credentials#

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

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

  • API Token (tokenApi) — Admin Center → Apps and integrations → APIs → Zendesk API.

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
subdominioSubdomaintextyesOnly the part before .zendesk.com (pasting the full URL is accepted).
emailAgent emailtextyesEmail of the user who created the API token.
tokenApi 🔒API Tokenpassword/secretyessecret (encrypted; external vault optional); Admin Center → Apps and integrations → APIs → Zendesk API.

Step-by-step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose Zendesk 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. Afterwards, Ativar agenda and Executar agora are separate actions.

Example — connection test#

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

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

Expected result#

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 cap per run (default 10.000 páginas / 5.000.000 linhas); anti-loop guard.
  • SaaS load: default batchSize 5.000, maxRows 200.000 per resource.
  • Estimated volume: ~0.5 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 per 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. The 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 errors/logs pass through secret redaction (raw, URL-encoded and in JSON).
  • Production does not fake: a path that would fall into mock triggers the production guard (explicit failure instead of simulating success).

Common errors#

  • Credential rejected (401/403) — the provider rejected the credential: expired, revoked or lacking necessary permission. 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.
  • Pagination cursor stuck — the extraction terminates when the API cursor doesn't advance (anti-loop guard). If it happens in repeated runs, open a support ticket informing the connector and the resource.
  • Empty records path — the response arrived without records where expected. 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 the 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/changed-type column = attention).

Related#


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

Related links