Read before:
../conectores.md(map of states) andfichas.md(index of the cards).
What it is#
Reads deals, people, companies and tasks from Agendor API v3 and loads into the Bronze layer.
Supported ingestion modes:
- Nós buscamos — We fetch the data from your source.
What it's for#
Bring Agendor 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 by 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 turned off (maintenance or incident). When this happens, the screen informs that the resource is unavailable at the moment.
Prerequisites#
- An Agendor account with access to the data you want to ingest.
- In Agendor, click your avatar → Profile → Integrations and copy the API Token (or generate a new one). Paste it below; the token is encrypted (AES-256-GCM) and never shown again. It reads the data visible to your user.
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 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 credentials vault is an explicit choice made per connection after saving — see ../../administracao/credenciais-e-rotacao.md.
- API Token (
tokenApi) — Personal API v3 token (Profile → Integrations).
Secrets are never re-displayed and go through redaction on every error/log (raw token, URL-encoded and in JSON).
Form fields#
| Field | Label | Type | Required | Note |
|---|---|---|---|---|
tokenApi 🔒 | API Token | password/secret | yes | secret (encrypted; external vault optional); Personal API v3 token (Profile → Integrations). |
Step by step#
- In the menu Dados → Conexões, use Nova conexão.
- Choose Agendor in the catalog.
- Fill in the form fields (see the table above).
- 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.
- Use Salvar conexão. Saving does NOT start any ingestion.
- 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.
- 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):
# Exemplo sintético (valores fictícios — não são credenciais reais)
tokenApi = •••••• (cifrado — nunca exibido)Expected result#
The 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 ceiling per run (default 10,000 pages / 5,000,000 rows); anti-loop guard.
- SaaS load: default
batchSize5,000,maxRows200,000 per resource. - Estimated volume: ~0.2 GB/month (catalog estimate, not measurement).
- Cost: the extraction itself is not billed by the platform; the 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 attached 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 secret redaction (raw, URL-encoded and in JSON).
- Production doesn't mock: a path that would hit 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 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-Afterand 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 issues before scheduling.
- Monitor runs in the connector observability (error rate, p50/p95, freshness).
- A schema change at the source is signaled by the schema drift (new column = info; removed/changed type column = attention).
Related#
../conectores.md— connector catalog by state../ingestao-incremental-backfill.md— full, incremental by watermark, backfill and checkpoint../pipeline-medalhao.md— Bronze/Silver/Gold layers and quality../agendamento-retry-dlq.md— scheduling, retry/backoff and DLQ../custo-limites-seguranca.md— cost, ceilings and workspace security
Last review: 2026-10-04. Card automatically generated from the product's connector catalog.