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:- In Orbit, open the APIs screen.
- Create a new key with a descriptive name (for example, “Nekt”).
- 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. - Copy the key.
members_salary_read permission. Leave it disabled if you don’t need salary data.- 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.
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.
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.
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.
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
Below you’ll find all available data streams from Orbit and their corresponding fields, grouped by Orbit module. API reference: Orbit APIs.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
Leads
Leads
crm_leads · Primary key: id · Sync: IncrementalPipelines
Pipelines
crm_pipelines · Primary key: id · Sync: Full tableStages
Stages
crm_stages · Primary key: id · Sync: Full tablePersons
Persons
crm_persons · Primary key: id · Sync: Full tableOrganizations
Organizations
crm_organizations · Primary key: id · Sync: Full tableProducts
Products
crm_products · Primary key: id · Sync: Full tableActivities
Activities
crm_activities · Primary key: id · Sync: Full tableNotes
Notes
crm_notes · Primary key: id · Sync: Full tableLoss Reasons
Loss Reasons
crm_loss_reasons · Primary key: id · Sync: Full tableLead Labels
Lead Labels
crm_lead_labels · Primary key: id · Sync: Full tableLead Sources
Lead Sources
crm_lead_sources · Primary key: id · Sync: Full tableLead Custom Fields
Lead Custom Fields
crm_lead_fields · Primary key: id · Sync: Full tableFinanceiro (finance)
Payables
Payables
finance_payables · Primary key: id · Sync: Full tableReceivables
Receivables
finance_receivables · Primary key: id · Sync: Full tableCustomers
Customers
finance_customers · Primary key: id · Sync: Full tableSuppliers
Suppliers
finance_suppliers · Primary key: id · Sync: Full tableChart of Accounts
Chart of Accounts
finance_chart_of_accounts · Primary key: id · Sync: Full tableCost Centers
Cost Centers
finance_cost_centers · Primary key: id · Sync: Full tableBank Accounts
Bank Accounts
finance_bank_accounts · Primary key: id · Sync: Full tableExpense Categories
Expense Categories
finance_expense_categories · Primary key: id · Sync: Full tablePayment Methods
Payment Methods
finance_payment_methods · Primary key: none · Sync: Full tableProjetos (projects)
Projects
Projects
projects · Primary key: id · Sync: Full tableProject Stages
Project Stages
project_stages · Primary key: id · Sync: Full tableProject Members
Project Members
project_members · Primary key: id · Sync: Full tableProject Notes
Project Notes
project_notes · Primary key: id · Sync: Full tableProject Folders
Project Folders
project_folders · Primary key: id · Sync: Full tablePessoas (people)
Members
Members
people_members · Primary key: id · Sync: Full tableJob Positions
Job Positions
people_job_positions · Primary key: id · Sync: Full tableIndicadores (indicators)
Indicators
Indicators
indicators · Primary key: id · Sync: Full tableIndicator Data Points
Indicator Data Points
indicator_data_points · Primary key: id · Sync: Full tableIndicator Analyses
Indicator Analyses
indicator_analyses · Primary key: id · Sync: Full tableIndicator Categories
Indicator Categories
indicator_categories · Primary key: id · Sync: Full tableIndicator Dashboards
Indicator Dashboards
indicator_dashboards · Primary key: id · Sync: Full tableProblemas (problems)
Problems
Problems
problems · Primary key: id · Sync: Full tableProblem Hypotheses
Problem Hypotheses
problem_hypotheses · Primary key: id · Sync: Full tableProblem Severities
Problem Severities
problem_severities · Primary key: id · Sync: Full tableProblem Frequencies
Problem Frequencies
problem_frequencies · Primary key: id · Sync: Full tableRiscos (risks)
Risks
Risks
risks · Primary key: id · Sync: Full tableRisk Probability Levels
Risk Probability Levels
risk_probability_levels · Primary key: id · Sync: Full tableRisk Impact Levels
Risk Impact Levels
risk_impact_levels · Primary key: id · Sync: Full tableOportunidades (opportunities)
Opportunities
Opportunities
opportunities · Primary key: id · Sync: Full tableOpportunity Probability Levels
Opportunity Probability Levels
opportunity_probability_levels · Primary key: id · Sync: Full tableOpportunity Impact Levels
Opportunity Impact Levels
opportunity_impact_levels · Primary key: id · Sync: Full table