Skip to content

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

Updated on 2026-10-04

Brevo — connector

Reads contacts, lists, email campaigns and transactional events from Brevo's v3 API and loads into the Bronze layer.

On this page (15)

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


What it is#

Reads contacts, lists, email campaigns and transactional events from Brevo's v3 API and loads into the Bronze layer.

Supported ingestion modes:

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

What it's for#

Bring Brevo 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 canceled, the run is blocked.
  • Shutdown: the ingestion run can be temporarily disabled (maintenance or incident). When this happens, the UI indicates the resource is unavailable at the moment.

Prerequisites#

  • A Brevo account with access to the data you want to ingest.
  • In Brevo (formerly Sendinblue), open the profile menu → SMTP & API → API Keys and generate a v3 key (it starts with xkeysib-). Paste it below; the key is encrypted (AES-256-GCM) and never shown again. The key needs read access to contacts, campaigns and transactional emails.

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 stored 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 credential vault is an explicit choice made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.

  • API Key (v3) (chaveApi) — v3 key generated in SMTP & API → API Keys. Sent in the api-key header on every call.

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

Form fields#

CampoRótuloTipoObrigatórioObservação
chaveApi 🔒Chave de API (v3)senha/segredosimsegredo (cifrado; cofre externo opcional); Chave v3 gerada em SMTP & API → Chaves de API. Vai no header api-key de toda chamada.

Step by step#

  1. No menu Dados → Conexões, use Nova conexão.
  2. Escolha Brevo no catálogo.
  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 are fictitious; secrets appear masked):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
chaveApi = •••••• (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 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.3 GB/month (catalog estimate, not measurement).
  • Cost: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).

Security#

  • Workspace scope: each customer reads and writes only in 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 stored. 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: every error/log goes through secrets redaction (raw, URL-encoded and in JSON).
  • Production does not mock: 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 successive runs, open a support ticket indicating 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 change = attention).

Related#


Last review: 2026-10-04. Fact sheet automatically generated from the product's connector catalog.

Related links