Availability

Airbyte Cloud Airbyte OSS PyAirbyte

Support Level

Community

Latest Version

0.5.0

Close.com

This page contains the setup guide and reference information for the Close.com source connector.

Prerequisites

• Close.com API Key

We recommend creating a restricted key specifically for Airbyte access. This will allow you to control which resources Airbyte should be able to access. For ease of use, we recommend using read permissions for all resources and configuring which resource to replicate in the Airbyte UI.

Setup guide

Step 1: Set up your Close.com API Key

1. Log in to your Close.com account.
2. At the bottom of the left navbar, select Settings.
3. In the left menu, select Developer.
4. At the top of the page, click + New API Key.

caution

For security purposes, the API Key will only be displayed once upon creation. Be sure to copy and store the key in a secure location.

For further reading on creating and maintaining Close.com API keys, refer to the official documentation.

Step 2: Set up the Close.com connector in Airbyte

1. Log in to your Airbyte Cloud account, or navigate to the Airbyte Open Source dashboard.
2. From the Airbyte UI, click Sources, then click on + New Source and select Close.com from the list of available sources.
3. Enter a Source name of your choosing.
4. In the API Key field, enter your Close.com API Key
5. Optional - In the Replication Start Date field, you may enter a starting date cutoff for the data you want to replicate. The format for this date should be as such: YYYY-MM-DD. Leaving this field blank will replicate all data.
6. Click Set up source and wait for the tests to complete.

Supported sync modes

The Close.com source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new/updated data, or all rows in the tables and columns you set up for replication. These settings will take effect every time a sync is run.

Supported streams

This source is capable of syncing the following core streams:

• Leads (Incremental)
• Created Activities (Incremental)
• Opportunity Status Change Activities (Incremental)
• Note Activities (Incremental)
• Meeting Activities (Incremental)
• Call Activities (Incremental)
• Email Activities (Incremental)
• Email Thread Activities (Incremental)
• Lead Status Change Activities (Incremental)
• SMS Activities (Incremental)
• Task Completed Activities (Incremental)
• Lead Tasks (Incremental)
• Incoming Email Tasks (Incremental)
• Email Followup Tasks (Incremental)
• Missed Call Tasks (Incremental)
• Answered Detached Call Tasks (Incremental)
• Voicemail Tasks (Incremental)
• Opportunity Due Tasks (Incremental)
• Incoming SMS Tasks (Incremental)
• Events (Incremental)
• Lead Custom Fields
• Contact Custom Fields
• Opportunity Custom Fields
• Activity Custom Fields
• Users
• Contacts
• Opportunities (Incremental)
• Roles
• Lead Statuses
• Opportunity Statuses
• Pipelines
• Email Templates
• Google Connected Accounts
• Custom Email Connected Accounts
• Zoom Connected Accounts
• Send As
• Email Sequences
• Dialer
• Smart Views
• Email Bulk Actions
• Sequence Subscription Bulk Actions
• Delete Bulk Actions
• Edit Bulk Actions
• Integration Links
• Custom Activities

Notes

Leads and Events Incremental streams use the date_updated field as a cursor. All other Incremental streams use the date_created field for the same purpose.

The SendAs stream requires payment.

Data type mapping

The Close.com API uses the same JSONSchema types that Airbyte uses internally (string, date-time, object, array, boolean, integer, and number), so no type conversions happen as part of this source.

Performance considerations

The Close.com connector is subject to rate limits. For more information on this topic, click here.

Reference

Config fields reference

Field

Type

Property name

string

api_key

string

start_date

Changelog

Version	Date	Pull Request	Subject
0.5.0	2023-11-30	32984	Add support for custom fields
0.4.3	2023-10-28	31534	Fixed Email Activities Stream Pagination
0.4.2	2023-08-08	29206	Fixed the issue with DatePicker format for start date
0.4.1	2023-07-04	27950	Add human readable titles to API Key and Start Date fields
0.4.0	2023-06-27	27776	Update the Email Followup Tasks stream schema
0.3.0	2023-05-12	26024	Update the Email sequences stream schema
0.2.2	2023-05-05	25868	Added CDK TypeTransformer to gurantee JSON Schema types, added missing properties for roles stream
0.2.1	2023-02-15	23074	Specified date formatting in specification
0.2.0	2022-11-04	18968	Migrate to Low-Code
0.1.0	2021-08-10	5366	Initial release of Close.com connector for Airbyte