Release Status Closed Beta Supported By Singer community
Availability Paid Status Page Close.io Status Page
Default Historical Sync 1 year Default Replication Frequency 30 minutes
Whitelisting Unsupported Destination Incompatibilities None

Connecting Close.io

Connecting your Close.io data to Stitch is a four-step process:

  1. Generate a Close.io API Key
  2. Add Close.io as a Stitch data source
  3. Define the Historical Sync
  4. Define the Replication Frequency

Generating a Close.io API Key

  1. Sign into your Close.io account.
  2. Click the user menu (your icon) in the top right corner.
  3. Click Settings.
  4. In the Company menu (located under the You menu), click Your API Keys.
  5. In the Your API Keys section, click the Generate New API Key button.
  6. 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

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Close.io icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Close.io” would create a schema called stitch_closeio in the destination. Note: Schema names cannot be changed after you save the integration.

  5. Paste your Close.io API Key into the API Key field.

Define 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 replicate data beyond Close.io’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Stitch offers two methods of creating a replication schedule:

  • Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
  • Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:

    • A Replication Frequency of at least one hour is required to use anchor scheduling.
    • An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

To help prevent overages, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Initial and historical replication jobs

After you finish setting up Close.io, its Sync Status may 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 replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


Close.io Schema

Stitch's Close.io integration includes these tables:


activities

Replication Method: Append-Only Incremental
Primary Key: id
Contains Nested Structures?: Yes

The activities table contains the activities performed on a lead or its contacts.

Table Info & Attributes

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: Key-based Incremental
Primary Key: id
Contains Nested Structures?: Yes

The leads table contains the leads in your Close.io account.

Table Info & Attributes

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: Key-based Incremental
Primary Key: id : _sdc_level_0_id
Contains Nested Structures?: No

The 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.

Table Info & Attributes

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



Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.