
Configuring CV CRM as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the CV CRM option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
You’ll need to provide your CV CRM credentials to authorize Nekt to access your data. The following configurations are available:- Email: The email address used to authenticate against the API service. This should be a valid email address with enough permissions to access the CV CRM data you want to extract. The email should be in the format
user@example.com. - API token: The authentication token required to access the API service. Please check this documentation to find more information about how to generate the token.
- Company subdomain: The subdomain identifier for your company account. For example, if your CRM URL is
https://mycompany.cvcrm.com.br, then your company subdomain would bemycompany. - Start date: The date from which you want to begin synchronizing data. This defines the earliest point in time for historical extraction. Any data created or modified before this date will not be included in the synchronization.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones. Select the streams and click Next.3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.- Layer: Choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: A folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: We suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: Depending on the data you are bringing to the lake, you can choose between INCREMENTAL and FULL_TABLE. Read more about Sync Types here.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:- Delta Log Retention: Determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
- Additional Full Sync: Determine when to execute an additional full sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Streams and Fields
Available streams
The table below lists every stream, its slug (the exact identifier to pass when creating the source via API) and a short description.Fields by stream
Below you’ll find all available data streams from CV CRM and their corresponding key fields:Leads
Leads
leads.Endpoint:/cvdw/leads
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Additional Fields
Additional Fields
additional_fields.Endpoint:/cvdw/campos_adicionais
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Sales
Sales
sales.Endpoint:/cvdw/vendas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Reservas
Reservas
reservas.Endpoint:/cvdw/reservas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Reservas Flags
Reservas Flags
reservas_flags.Endpoint:/cvdw/reservas/registros/flags
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Pre Cadastros
Pre Cadastros
pre_cadastros.Endpoint:/cvdw/precadastros
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Leads Visitas
Leads Visitas
leads_visitas.Endpoint:/cvdw/leads/visitas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Corretores
Corretores
corretores.Endpoint:/cvdw/corretores
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Imobiliarias
Imobiliarias
imobiliarias.Endpoint:/cvdw/imobiliarias
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Pessoas
Pessoas
pessoas.Endpoint:/cvdw/pessoas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Empreendimentos
Empreendimentos
empreendimentos.Endpoint:/cadastros/empreendimentos
- Full table (no replication key configured)
- Primary key(s):
idempreendimento
Campanhas Ativacao
Campanhas Ativacao
campanhas_ativacao.Endpoint:/cvdw/campanhas_ativacao
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Unidades
Unidades
unidades.Endpoint:/cvdw/unidades
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Distratos
Distratos
distratos.Endpoint:/cvdw/distratos
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Leads Interacoes
Leads Interacoes
leads_interacoes.Endpoint:/cvdw/leads/interacoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Leads Tarefas
Leads Tarefas
leads_tarefas.Endpoint:/cvdw/leads/tarefas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Leads Historico Situacoes
Leads Historico Situacoes
leads_historico_situacoes.Endpoint:/cvdw/leads/historico/situacoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Comissoes
Comissoes
comissoes.Endpoint:/cvdw/comissoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Comissoes Detalhes
Comissoes Detalhes
comissoes_detalhes.Endpoint:/financeiro/comissoes
- Full table (no replication key configured)
- Primary key(s):
idcomissao_cv
comissoes stream, this endpoint exposes the payer, the beneficiaries with their payment schedule, payment batches, payment document metadata, and payment records.Key Fields:Atendimentos
Atendimentos
atendimentos.Endpoint:/cvdw/atendimentos
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Assistencias
Assistencias
assistencias.Endpoint:/cvdw/assistencias
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Leads Conversoes
Leads Conversoes
leads_conversoes.Endpoint:/cvdw/leads/conversoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Repasses
Repasses
repasses.Endpoint:/cvdw/repasses
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Leads Workflow Tempo
Leads Workflow Tempo
leads_workflow_tempo.Endpoint:/cvdw/leads/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Reservas Condicoes
Reservas Condicoes
reservas_condicoes.Endpoint:/cvdw/reservas/condicoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Reservas Contratos
Reservas Contratos
reservas_contratos.Endpoint:/cvdw/reservas/contratos
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Reservas Sienge
Reservas Sienge
reservas_sienge.Endpoint:/cvdw/reservas/sienge
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Leads Corretores
Leads Corretores
leads_corretores.Endpoint:/cvdw/leads/corretores
- Incremental replication key:
referencia_data - Primary key(s):
idlead, idcorretor, data_cad
Unidades Situacao
Unidades Situacao
unidades_situacao.Endpoint:/cvdw/unidades/situacao
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Pre Cadastros Historico Situacoes
Pre Cadastros Historico Situacoes
pre_cadastros_historico_situacoes.Endpoint:/cvdw/precadastro/historico/situacoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Distribuicao Leads
Distribuicao Leads
distribuicao_leads.Endpoint:/cvdw/distribuicao/leads
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Empreendimentos Cvbot
Empreendimentos Cvbot
empreendimentos_cvbot.Endpoint:/cvbot/empreendimentos
- Full table (no replication key configured)
- Primary key(s):
idempreendimento
Empreendimentos Unidades Cvbot
Empreendimentos Unidades Cvbot
empreendimentos_unidades_cvbot.Endpoint:/cvbot/empreendimentos/{idempreendimento}/unidades
- Full table (no replication key configured)
- Primary key(s):
idunidade
Pessoas Profissional
Pessoas Profissional
pessoas_profissional.Endpoint:/cvdw/pessoas/profissional
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Tipologias Unidades
Tipologias Unidades
tipologias_unidades.Endpoint:/configuracoes/tipologias-unidades
- Full table (no replication key configured)
- Primary key(s):
idtipologia
Reservas Associados
Reservas Associados
reservas_associados.Endpoint:/cvdw/reservas/associados
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Usuarios Administrativos
Usuarios Administrativos
usuarios_administrativos.Endpoint:/cvdw/usuarios_administrativos
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Pesquisas
Pesquisas
pesquisas.Endpoint:/cvdw/pesquisas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Pesquisas Perguntas
Pesquisas Perguntas
pesquisas_perguntas.Endpoint:/cvdw/pesquisas/perguntas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Pesquisas Respostas
Pesquisas Respostas
pesquisas_respostas.Endpoint:/cvdw/pesquisas/respostas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Assistencias Itens
Assistencias Itens
assistencias_itens.Endpoint:/cvdw/assistencias/itens
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Assistencias Workflow Tempo
Assistencias Workflow Tempo
assistencias_workflow_tempo.Endpoint:/cvdw/assistencias/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Assistencias Itens Workflow Tempo
Assistencias Itens Workflow Tempo
assistencias_itens_workflow_tempo.Endpoint:/cvdw/assistencias/itens/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Assistencias Visitas Workflow Tempo
Assistencias Visitas Workflow Tempo
assistencias_visitas_workflow_tempo.Endpoint:/cvdw/assistencias/visitas/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Atendimentos Respostas
Atendimentos Respostas
atendimentos_respostas.Endpoint:/cvdw/atendimentos/respostas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Atendimentos Workflow Tempo
Atendimentos Workflow Tempo
atendimentos_workflow_tempo.Endpoint:/cvdw/atendimentos/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Atendimentos Interacoes
Atendimentos Interacoes
atendimentos_interacoes.Endpoint:/cvdw/atendimentos/interacoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Unidades Precos
Unidades Precos
unidades_precos.Endpoint:/cvdw/unidades/precos
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Atendimentos Times
Atendimentos Times
atendimentos_times.Endpoint:/cvdw/atendimentos/times
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Atendimentos Times Integrantes
Atendimentos Times Integrantes
atendimentos_times_integrantes.Endpoint:/cvdw/atendimentos/times/integrantes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Atendimentos Tarefas
Atendimentos Tarefas
atendimentos_tarefas.Endpoint:/cvdw/atendimentos/tarefas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Reservas Workflow Tempo
Reservas Workflow Tempo
reservas_workflow_tempo.Endpoint:/cvdw/reservas/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Repasses Historico Situacoes
Repasses Historico Situacoes
repasses_historico_situacoes.Endpoint:/cvdw/repasses/historico/situacoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
Implementation Notes
Empty Response Handling
The CV CRM connector safely handles204 No Content and empty body responses from the API, particularly on paginated endpoints. This prevents data pipeline failures when specific data streams or pages return no data during the synchronization window.
Some endpoints (for example Empreendimentos Unidades CVbot or Unidades) signal “no data” with an HTTP 400 Bad Request whose body is {"error": "Nenhum dado encontrado!"} (for instance, an empreendimento with no units). The connector recognizes this payload and treats it as an empty page instead of a fatal error, so the sync continues without failing.
Commission Details Sync Behavior
Thecomissoes_detalhes stream always runs as a full refresh (FULL_TABLE). Commissions are frequently updated in place (status changes, new payment records), and the API’s a_partir_de date filter only covers the initial registration date, so a full sync ensures that all subsequent state changes to existing commissions are accurately captured.
Financeiro Pagination
The/financeiro/comissoes endpoint returns pagination metadata (total, limit, offset, totalConteudo) as string values. The connector coerces these values to integers and advances the offset by the number of records the API actually returned, so pagination stays correct even if the server caps the requested page size.
Transfer Status History Sync Behavior
For therepasses_historico_situacoes stream, CV CRM applies the incremental filter (a_partir_data_referencia) to the parent transfer (repasse), not to the individual history row, and returns the complete status history for that transfer. As a result, rows may be returned that are older than the incremental filter date. The connector safely handles this by updating the state bookmark to the maximum timestamp seen across all records at the end of the sync, without assuming chronological sorting.