This integration was created by Stitch for Singer, an open-source, composable ETL platform. Check out & contribute to the repo on GitHub.
Close.io is currently in Open Beta. The info in this article is subject to change.
Release Status | Open Beta | Availability | Premium |
Status Page | Close.io Status Page | Default Historical Sync | 1 year |
Whitelist Tables/Columns | Unsupported/Unsupported | Default Replication Frequency | 30 minutes |
Full Table Endpoints | 0 | Incremental Endpoints | 3 |
Destination Incompatibilities | None |
Connecting Close.io
Connecting your Close.io data to Stitch is a four-step process:
- Generate a Close.io API Key
- Add Close.io as a Stitch data source
- Define the Historical Sync
- Define the Replication Frequency
Generating a Close.io API Key
- Sign into your Close.io account.
- Click the user menu (your icon) in the top right corner.
- Click Settings.
- In the Company menu (located under the You menu), click Your API Keys.
- In the Your API Keys section, click the Generate New API Key button.
- A new API Key will display. Keep this handy; you’ll need it in the next step.
Add Close.io as a Stitch Data Source
- On the Stitch Dashboard page, click the Add an Integration button.
-
Click the Close.io icon.
-
Enter a name for the integration. This is the name that will display on the for the integration; it’ll also be used to create the schema in your data warehouse.
For example, the name “Stitch Closeio” would create a schema called
stitch_closeio
in the data warehouse. This schema is where all the tables for this integration will be stored. - Paste your Close.io API Key into the API Key field.
Defining the Historical Sync
The Sync Historical Data setting will define the starting date for your Close.io integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to sync data beyond Close.io’s default setting of 1 year. For a detailed look at historical syncs, check out the Syncing Historical SaaS Data article.
Define the Replication Frequency
The Replication Frequency controls how often Stitch will attempt to replicate data from your Close.io integration. By default the frequency is set to 30 minutes, but you can change it to better suit your needs.
Before setting the Replication Frequency, note that:
- The more often Close.io is set to replicate, the higher the number of replicated rows.
-
The number of rows in the source may not equal the number of rows replicated by Stitch. Tables that use Full Table Replication will result in a higher number of replicated rows.
- If you’re using a data warehouses that doesn’t natively support nested structures, you’ll see a higher number of replicated rows due to the de-nesting Stitch performs.
To help prevent overages, we recommend setting the Replication Frequency to something less frequent - like 6 hours instead of 30 minutes. For tips on reducing your row count, check out the Reducing Your Row Count section of our Billing Guide.
After selecting a Replication Frequency, click Save Integration.
Close.io’s Intial Sync
After you finish setting up Close.io, you might see its Sync Status show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial sync for the integration. This may take some time to complete.
Close.io Schema
Stitch's Close.io integration includes these tables:
activities
Replication Method: Append-Only Incremental
Primary Key: id
Contains Nested Structures?:
Yes
activities
table contains the activities performed on a lead or its contacts.activities & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
Activity Types & Subtables
Depending on the type of activity - EmailThread
, for example - you may see subtables, as these record types contain nested data structures.
Append-Only Replication
This table is Append-Only. Whenever an existing row is updated, it will be appended to the end of the table as a new row.
activities Attributes
While we try to include everything Close.io has here, this may not be a full list of attributes. Refer to Close.io's documentation for a full list and description of each attribute.
Activity ID (
id
)envelope
properties
*
message_id
sender
*
date
subject
is_autoreply
from
*
bcc
*
reply_to
to
*
in_reply_to
*
date_created
references
*
body_text_quoted
*
need_smtp_credentials
in_reply_to_id
updated_by_name
old_status_label
transferred_from
user_id
updated_by
cc
*
opportunity_value
task_assigned_to
created_by
status
email_account_id
template_id
transferred_to
attachments
*
message_ids
*
voicemail_duration
local_phone
body_html_quoted
*
opens
*
task_id
lead_id
task_assigned_to_name
body_text
thread_id
task_text
user_name
note
source
import_id
to
*
recording_url
date_scheduled
subject
body_preview
created_by_name
phone
sender
duration
date_sent
_type
new_status_label
opportunity_value_formatted
opportunity_id
opens_summary
new_status_type
remote_phone
new_status_id
contact_id
body_html
opportunity_date_won
opportunity_value_currency
old_status_type
bcc
*
organization_id
old_status_id
opportunity_confidence
date_updated
template_name
opportunity_value_period
voicemail_url
send_attempts
*
direction
leads
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
leads
table contains the leads in your Close.io account.leads & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
leads Attributes
While we try to include everything Close.io has here, this may not be a full list of attributes. Refer to Close.io's documentation for a full list and description of each attribute.
Lead ID (
id
)integration_links
*
description
updated_by
status_id
opportunities
*
organization_id
date_updated
created_by
tasks
*
status_label
created_by_name
date_created
contacts
*
updated_by_name
display_name
html_url
addresses
*
name
url
leads__opportunities
Replication Method: Incremental
Primary Key: id : _sdc_level_0_id
Contains Nested Structures?:
No
leads__opportunities
table contains info about the opportunities associated with the leads in your Close.io account. This subtable will only be created if your data warehouse doesn't natively support nested data structures.leads__opportunities Attributes
While we try to include everything Close.io has here, this may not be a full list of attributes. Refer to Close.io's documentation for a full list and description of each attribute.
Lead ID (
id
)Row ID (_sdc_level_0_id)
items__value
items__date_lost
items__created_by
items__user_id
items__contact_id
items__updated_by_name
items__updated_by
items__status_id
items__user_name
items__organization_id
items__value_formatted
items__date_created
items__id
items__value_currency
items__value_period
items__lead_id
items__confidence
items__contact_name
items__date_updated
items__status_label
items__note
items__lead_name
items__status_type
items__created_by_name
items__date_won
Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, please reach out to us.