Skip to content

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

Updated on 2026-10-04

Intercom — connector

Reads contacts, conversations and companies from the Intercom API (version 2.11) and loads into the Bronze layer.

On this page (15)

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


What it is#

Reads contacts, conversations and companies from the Intercom API (version 2.11) and loads into the Bronze layer.

Supported ingestion modes:

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

Purpose#

Bring Intercom 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 in the plan).
  • Access: requires an active workspace — with the subscription overdue, suspended or cancelled, execution is blocked.
  • Shutdown: the ingestion execution may be turned off temporarily (maintenance or incident). When this happens, the screen reports that the feature is unavailable at the moment.

Prerequisites#

  • An Intercom account with access to the data you want to ingest.
  • In Intercom, go to Settings → Integrations → Developer Hub, create an internal app (or open the existing one) and copy the Access Token in Authentication. Paste below; the token is encrypted (AES-256-GCM) and never shown again. Needs read permissions for contacts, conversations and companies.

Credentials#

Authentication method: Access Token pasted by you. It is encrypted (AES-256-GCM) and never shown again, nor appears in logs or error messages.

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

  • Access Token (tokenAcesso) — Token from the internal app (Developer Hub → your app → Authentication).

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
tokenAcesso 🔒Access Tokenpassword/secretyessecret (encrypted; external vault optional); Token from the internal app (Developer Hub → your app → Authentication).

Step-by-step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose Intercom from the catalogue.
  3. Fill in 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)
tokenAcesso = •••••• (cifrado — nunca exibido)

Expected result#

The Testar conexão returns the list of discovered tables/resources. After the first load, the rows appear in the Bronze layer of your workspace, 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.5 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 written. The external credentials vault is optional and enabled per connection; without it, the encrypted value remains in the database. Changing the value here does NOT revoke the credential at the source.
  • Redaction: all errors/logs go through secrets 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 did not accept the credential: expired, revoked or lacking required 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 stops when the API cursor does not advance (anti-loop guard). If it happens in consecutive 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 issues 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; removed/changed type = attention).

Related#


Last review: 2026-10-04. Card automatically generated from the product connectors catalogue.

Related links