Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nekt.com/llms.txt

Use this file to discover all available pages before exploring further.

Rubeus is a CRM platform designed for educational institutions that helps manage contacts, courses, enrollment processes, events, and student lifecycle. It provides tools for admissions, marketing automation, and relationship management in the education sector.

​
Configuring Rubeus as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Rubeus 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 Rubeus API credentials. These can be found in your Rubeus CRM under Settings > Integrations > Channels. The following configurations are available:
  • API Token: Your unique API token for authentication. Found in the channel settings of your Rubeus CRM instance.
  • Channel Code (Origem): The channel identification code associated with your API token. This is a numeric value found alongside your API token in the channel settings.
  • CRM URL: The base URL of your Rubeus CRM instance (e.g., https://crm.yourcompany.com.br).
  • Start Date: The earliest date from which records will be synced for incremental streams (currently applies to the Logs stream).
Once you’re done, click Next.

​
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.
Tip: The stream can be found more easily by typing its name.
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: you can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: every time the extraction happens, we’ll get only the new data, which is good if, for example, you want to keep every record ever fetched.
    • Full table: every time the extraction happens, we’ll get the current state of the data, which is good if, for example, you don’t want to have deleted data in your catalog.
Once you are done configuring, click Next.

​
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:
  • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
  • 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.
Once you are ready, click Next to finalize the setup.

​
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.
For you to be able to see it on your Catalog, you need at least one successful source run.

​
Streams and Fields

Below you’ll find all available data streams from Rubeus and their corresponding fields:
List of courses offered by the institution.Fields:
  • id - Unique identifier for the course
  • nome - Course name
  • descricao - Course description
  • codigo - Course code
  • origem - Origin channel ID
  • origemNome - Origin channel name
List of course offerings with enrollment periods and associated metadata.Fields:
  • id - Unique identifier for the offering
  • nome - Offering name
  • complemento - Additional information
  • codigo - Offering code
  • codCurso - Associated course code
  • inicioInscricao - Enrollment start date
  • terminoInscricao - Enrollment end date
  • inicioMatricula - Registration start date
  • terminoMatricula - Registration end date
  • unidade - Unit ID
  • unidadeNome - Unit name
  • nivelEnsino - Education level ID
  • nivelEnsinoNome - Education level name
  • modalidade - Modality ID
  • modalidadeNome - Modality name
  • origem - Origin channel ID
  • origemNome - Origin channel name
  • processoSeletivo - Selective process ID
  • codProcessoSeletivo - Selective process code
  • processoSeletivoNome - Selective process name
List of teaching modalities (e.g., in-person, online, hybrid).Fields:
  • id - Unique identifier
  • codigo - Modality code
  • titulo - Modality title
List of institutional units/campuses.Fields:
  • id - Unique identifier
  • nome - Unit name
  • descricao - Unit description
  • codigo - Unit code
Physical locations where courses are offered.Fields:
  • id - Unique identifier
  • codigo - Location code
  • titulo - Location title
  • descricao - Location description
  • telefone - Phone number
  • email - Email address
  • endereco - Street address
  • numero - Address number
  • bairro - Neighborhood
  • cep - Postal code (CEP)
  • cidade - City
Contact records from the CRM, including students, leads, and related persons.Fields:
  • id - Unique identifier
  • nome - Full name
  • nomeSocial - Social/preferred name
  • codigo - Contact code
  • cpf - CPF document number
  • datanascimento - Date of birth
  • endereco - Street address
  • cep - Postal code
  • numero - Address number
  • bairro - Neighborhood
  • cidade - City ID
  • cidadeNome - City name
  • sexo - Gender ID
  • sexoNome - Gender name
  • origemId - Origin channel ID
  • origemNome - Origin channel name
  • profissao - Profession
  • aluno - Whether the contact is a student
  • exaluno - Whether the contact is a former student
  • anoFormacao - Graduation year
  • estadoCivil - Marital status ID
  • estadoCivilNome - Marital status name
  • cor - Race/ethnicity ID
  • corNome - Race/ethnicity name
  • grauInstrucao - Education level ID
  • grauInstrucaoNome - Education level name
  • verificada - Whether the contact has been verified
  • desinscreveu - Whether the contact unsubscribed
  • telefone_principal - Primary phone number
  • email_principal - Primary email address
  • tags - Contact tags (JSON)
  • camposPersonalizados - Custom fields (JSON)
List of available contact type categories.Fields:
  • id - Unique identifier
  • titulo - Type title
Custom fields configured in the institution’s Rubeus instance.Fields:
  • id - Unique identifier
  • nome - Field name
  • coluna - Column identifier
  • tipo - Field type ID (1=string, 2=longtext, 3=integer, 4=date, 5=boolean)
  • tipoNome - Field type name
  • tipoLocal - Location type ID (1=contact, 2=process record, 3=course)
  • tipoLocalNome - Location type name
Types of events that can be tracked in the CRM.Fields:
  • id - Unique identifier
  • codigo - Event type code
  • titulo - Event type title
  • formaCriacaoOportunidade - Opportunity creation method
List of education/teaching levels.Fields:
  • id - Unique identifier
  • codigo - Level code
  • titulo - Level title
  • padrao - Whether this is a default level
User profiles and their permissions within the CRM.Fields:
  • id - Unique identifier
  • nome - Profile name
  • cor - Profile color
  • permissoes - Permissions (JSON)
  • ultimaAlteracao - Last modification date
Reference list of countries.Fields:
  • id - Unique identifier
  • sigla - Country code (ISO)
  • nome - Country name
Reference list of cities available in the CRM.Fields:
  • id - Unique identifier
  • titulo - City name
API interaction logs with incremental sync support via date range filtering.Fields:
  • dados - Request data (JSON)
  • resposta - Response data (JSON)
  • metodo - API method called
  • sucesso - Whether the call was successful
  • origem - Origin channel ID
  • origemNome - Origin channel name
  • momento - Timestamp of the API call