Skip to main content
Orbit (Orbit Gestão) is a Brazilian management platform for small and medium businesses that brings together CRM, finance, projects, people, indicators, problems, risks and opportunities. The connector uses the Orbit APIs to extract your sales funnel (leads, pipelines, contacts, products and activities), your accounts payable and receivable with their catalogs, your projects, your team and job positions, your indicators with their measurements, and your problems, risks and opportunities. With it you can analyze your sales, your finances and your operation in your Lakehouse.

Configuring Orbit as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Orbit option from the list of connectors. Click Next and you’ll be prompted to add your access.

1. Add account access

Orbit gives access to your data through an API key. One key works for every module; what the key can read depends on the permissions you enable when you create it. To create the key:
  1. In Orbit, open the APIs screen.
  2. Create a new key with a descriptive name (for example, “Nekt”).
  3. Enable the read permissions (the ones ending in _read) of every module you want to extract: CRM, Financeiro, Projetos, Pessoas, Indicadores, Problemas, Riscos and Oportunidades. Read permissions are enough: the connector never writes to Orbit.
  4. Copy the key.
The employees’ salary is only extracted when the key has the members_salary_read permission. Leave it disabled if you don’t need salary data.
The following configurations are available:
  • API Key: the Orbit API key created in the APIs screen. Required.
  • Start Date (advanced): the earliest last-update date of the leads read on the first sync. Later syncs continue from where the previous one stopped. Leave it empty to read every lead. The other streams are always extracted in full.
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.
If the API key does not have the read permission of a stream, that stream is skipped and the run log shows a warning naming it; the other streams are extracted normally. Enable the permission on the key in Orbit, or deselect the stream.
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: leads are INCREMENTAL: each sync brings the leads that changed since the previous one. The other streams are FULL_TABLE: each sync replaces the table with what Orbit currently holds. Read more about Sync Types here.
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.
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 Orbit and their corresponding fields, grouped by Orbit module. API reference: Orbit APIs.
Lists and objects are stored as JSON text, and money values are in reais (not cents). Every table also has an additional_fields column: it keeps, as JSON, any field Orbit returns that does not have its own column yet, so no data is lost while new columns are added.
crm_persons, crm_organizations and finance_customers read the same customer register in Orbit: persons and customers list every customer, organizations only the companies.

CRM

Opportunity cards of the sales funnels, read incrementally by update time.Table: crm_leads · Primary key: id · Sync: Incremental
Active sales funnels, with their stages embedded.Table: crm_pipelines · Primary key: id · Sync: Full table
Stages (Kanban columns) of every funnel.Table: crm_stages · Primary key: id · Sync: Full table
Contacts (customers) as seen by the CRM.Table: crm_persons · Primary key: id · Sync: Full table
Company customers (customer_type = company) as seen by the CRM.Table: crm_organizations · Primary key: id · Sync: Full table
Commercial product and service catalog.Table: crm_products · Primary key: id · Sync: Full table
Tasks, calls and meetings on the leads’ timelines.Table: crm_activities · Primary key: id · Sync: Full table
Notes written on the leads.Table: crm_notes · Primary key: id · Sync: Full table
Active reasons available when marking a lead as lost.Table: crm_loss_reasons · Primary key: id · Sync: Full table
Labels that can be applied to leads.Table: crm_lead_labels · Primary key: id · Sync: Full table
Lead origins configured in the CRM.Table: crm_lead_sources · Primary key: id · Sync: Full table
Active custom field definitions of the leads.Table: crm_lead_fields · Primary key: id · Sync: Full table

Financeiro (finance)

Accounts payable (bills to suppliers).Table: finance_payables · Primary key: id · Sync: Full table
Accounts receivable (bills to customers).Table: finance_receivables · Primary key: id · Sync: Full table
Customer register of the finance module (accounts receivable).Table: finance_customers · Primary key: id · Sync: Full table
Supplier register of the finance module (accounts payable).Table: finance_suppliers · Primary key: id · Sync: Full table
Chart of accounts.Table: finance_chart_of_accounts · Primary key: id · Sync: Full table
Cost centers.Table: finance_cost_centers · Primary key: id · Sync: Full table
Bank accounts of the organization.Table: finance_bank_accounts · Primary key: id · Sync: Full table
Expense categories (read-only catalog).Table: finance_expense_categories · Primary key: id · Sync: Full table
Payment methods (read-only catalog).Table: finance_payment_methods · Primary key: none · Sync: Full table

Projetos (projects)

Projects of the organization (read in full on every run so their children see every project).Table: projects · Primary key: id · Sync: Full table
Stages (Kanban columns) of each project. Read with one request per record of Projects; requires the Projects stream.Table: project_stages · Primary key: id · Sync: Full table
Members of each project. Read with one request per record of Projects; requires the Projects stream.Table: project_members · Primary key: id · Sync: Full table
Notes of each project. Read with one request per record of Projects; requires the Projects stream.Table: project_notes · Primary key: id · Sync: Full table
Folders that organize the projects.Table: project_folders · Primary key: id · Sync: Full table

Pessoas (people)

Members (employees) of the organization, including removed ones.Table: people_members · Primary key: id · Sync: Full table
Job positions (roles) with their description, competencies and hierarchy.Table: people_job_positions · Primary key: id · Sync: Full table

Indicadores (indicators)

Indicators (KPIs) of every kind: standalone, process and quality control.Table: indicators · Primary key: id · Sync: Full table
Measurements (data points) of each indicator. Read with one request per record of Indicators; requires the Indicators stream.Table: indicator_data_points · Primary key: id · Sync: Full table
Written analyses of each indicator. Read with one request per record of Indicators; requires the Indicators stream.Table: indicator_analyses · Primary key: id · Sync: Full table
Categories that group the indicators.Table: indicator_categories · Primary key: id · Sync: Full table
Indicator dashboards.Table: indicator_dashboards · Primary key: id · Sync: Full table

Problemas (problems)

Operational problems registered in Orbit.Table: problems · Primary key: id · Sync: Full table
Hypotheses raised for the problems.Table: problem_hypotheses · Primary key: id · Sync: Full table
Severity levels available for problems.Table: problem_severities · Primary key: id · Sync: Full table
Frequency levels available for problems.Table: problem_frequencies · Primary key: id · Sync: Full table

Riscos (risks)

Risks (threats) registered in Orbit.Table: risks · Primary key: id · Sync: Full table
Probability levels of the risk matrix.Table: risk_probability_levels · Primary key: id · Sync: Full table
Impact levels of the risk matrix.Table: risk_impact_levels · Primary key: id · Sync: Full table

Oportunidades (opportunities)

Opportunities of the Opportunities module (not CRM leads).Table: opportunities · Primary key: id · Sync: Full table
Probability levels of the opportunity matrix.Table: opportunity_probability_levels · Primary key: id · Sync: Full table
Impact levels of the opportunity matrix.Table: opportunity_impact_levels · Primary key: id · Sync: Full table