Configuring Syncro as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Syncro option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
The connector authenticates with a Syncro API key. To create one:1
Open the API Keys page
In Syncro, go to Configurações → API Keys.
2
Create a key
Click Nova API Key, give it a name (for example, “Nekt”), and confirm.
3
Copy the key
Copy the key right away. It starts with
crm_, and Syncro shows it only once. If you lose it, delete it and create a new one.A new key has access to everything the connector reads. If you restrict the key’s permissions, keep the read permission of every stream you select (for example,
leads:read for leads and tasks:read for tasks); otherwise the sync stops and names the missing permission.- API Key: the Syncro API key. 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. Tasks, pipelines, and the other lists 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.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 changed since the previous one. The other streams are FULL_TABLE: each sync replaces the table with what Syncro 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 Syncro and their corresponding fields. API reference: Syncro API.Lists and objects (such as the products, contacts, and sales of a lead) are stored as JSON text. Syncro allows 60 requests per minute per API key, shared with any other integration that uses the same key; the connector stays below that and, when Syncro asks it to slow down, waits and continues automatically.
Leads
Leads
Leads (deals) of your CRM with their products, contacts, notes, won and lost sales, tasks, nurture sequences and score. Incremental: each sync reads the leads changed since the previous one (from one day before, as Syncro filters by date).Table:
leads · Primary key: id · Sync: Incremental · Replication key: synced_atTasks
Tasks
Tasks of your team, linked to a lead or standalone. Extracted in full on every sync.Table:
tasks · Primary key: id · Sync: Full tablePipelines
Pipelines
Sales pipelines (funnels) of the account. Extracted in full on every sync.Table:
pipelines · Primary key: id · Sync: Full tablePipeline Stages
Pipeline Stages
Stages of every pipeline, in pipeline order, with the flags that mark won and lost stages. Use it to name the
stage_id of leads. Extracted in full on every sync.Table: pipeline_stages · Primary key: id · Sync: Full tableLost Reasons
Lost Reasons
Reasons a deal can be marked as lost;
reason_id in the lost sales of a lead refers to this list. Extracted in full on every sync.Table: lost_reasons · Primary key: id · Sync: Full tableCustom Fields
Custom Fields
Definitions of the lead custom fields, active or not. Their
name is the key used in the custom_fields column of the leads table. Extracted in full on every sync.Table: custom_fields · Primary key: id · Sync: Full tableNurture Sequences
Nurture Sequences
Nurture sequences (automated message cadences), active or not. Extracted in full on every sync.Table:
nurture_sequences · Primary key: id · Sync: Full tableUsers
Users
Users of your Syncro account. Extracted in full on every sync.Table:
users · Primary key: id · Sync: Full tableAccount
Account
The Syncro account the API key belongs to (one row). Extracted in full on every sync.Table:
account · Primary key: id · Sync: Full table