Skip to content

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

Updated on 2026-10-04

Salesforce — connector

Reads CRM Salesforce objects (Account, Contact, Opportunity, Lead and custom objects) via SOQL and loads into the Bronze layer.

On this page (15)

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


What it is#

Reads CRM Salesforce objects (Account, Contact, Opportunity, Lead and custom objects) via SOQL and loads into the Bronze layer.

Supported ingestion modes:

  • Nós buscamos — We pull the data from your source.

What it's for#

Bring Salesforce 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 overdue, suspended or canceled subscription, the run is blocked.
  • Shutdown: ingestion runs can be temporarily disabled (maintenance or incident). When that happens, the screen indicates the resource is unavailable at the moment.

Prerequisites#

  • A Salesforce account with access to the data you want to ingest.
  • Create a Connected App in Salesforce (Setup → App Manager) with OAuth and read scopes (api, refresh_token) and provide the instance URL, Consumer Key/Secret and a refresh token. Secrets are encrypted (AES-256-GCM) and are never shown again. If authorization expires, simply reconnect — the source and history are preserved.

Credentials#

Authentication method: OAuth 2.0 (client id/secret + refresh token). All secrets are encrypted (AES-256-GCM) and never shown again. If authorization expires, simply reconnect — the source and history are preserved.

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

  • Consumer secret (clientSecret)
  • Refresh token (refreshToken) — Issued in the OAuth authorization flow. If it expires or is revoked, reconnect the account — there is no need to recreate the source.

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

Form fields#

CampoRótuloTipoObrigatórioObservação
instanceUrlURL da instânciatextosimA URL que aparece após o login (My Domain). Sem barra no final.
objectsObjetostextonãoSepare por vírgula ou ponto e vírgula. Aceita objetos customizados (terminados em __c). Vazio = Account, Contact, Opportunity e Lead.
loginUrlURL de login (sandbox)textonãoSó mude para https://test.salesforce.com se a conexão for com uma sandbox.
clientIdConsumer keytextosim—
clientSecret 🔒Consumer secretsenha/segredosimsegredo (cifrado; cofre externo opcional)
refreshToken 🔒Refresh tokensenha/segredosimsegredo (cifrado; cofre externo opcional); Emitido no fluxo de autorização OAuth. Se expirar ou for revogado, reconecte a conta — não é preciso recriar a fonte.

(Note: the table headers and form field labels above are preserved in Portuguese as part of the product UI labels.)

Step by step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose Salesforce in the catalog.
  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 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 are fictitious; secrets appear masked):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
instanceUrl = https://exemplo.my.salesforce.com
objects = Account; Contact
loginUrl = https://login.salesforce.com
clientId = exemplo-client-id-ficticio
clientSecret = •••••• (cifrado — nunca exibido)
refreshToken = •••••• (cifrado — nunca exibido)

Expected result#

The Testar conexão returns the list of discovered tables/resources. After the first load, the 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: ~1 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 go through secret redaction (raw, URL-encoded and in JSON).
  • No production fakes: a path that would fall into a mock triggers the production guard (explicit fail instead of simulating success).

Common errors#

  • Credential rejected (401/403) — the provider did not accept the credential: expired, revoked or missing 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 successive runs, open a support ticket stating the connector and 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 the observability per connector (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. Ficha gerada automaticamente do catálogo de conectores do produto.

Related links