ContextQMD
Back to Airbyte

Close.com

docs/integrations/sources/close-com.md

2.0.013.3 KB
Original Source

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:

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.

Changelog

<details> <summary>Expand to review</summary>
VersionDatePull RequestSubject
0.6.152025-05-1059969Update dependencies
0.6.142025-05-0359433Update dependencies
0.6.132025-04-2658896Update dependencies
0.6.122025-04-1958308Update dependencies
0.6.112025-04-1257797Update dependencies
0.6.102025-04-0557247Update dependencies
0.6.92025-03-2956484Update dependencies
0.6.82025-03-2255989Update dependencies
0.6.72025-03-0855343Update dependencies
0.6.62025-03-0154454Update dependencies
0.6.52025-02-1553747Update dependencies
0.6.42025-02-0853329Update dependencies
0.6.32025-02-0152940Update dependencies
0.6.22025-01-2552306Update dependencies
0.6.12025-01-1851625Update dependencies
0.6.02025-01-1650431Migrate to manifest-only
0.5.302025-01-1151119Update dependencies
0.5.292025-01-0450920Update dependencies
0.5.282024-12-2850532Update dependencies
0.5.272024-12-2150065Update dependencies
0.5.262024-12-1448918Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.5.252024-11-0447933Update dependencies
0.5.242024-10-2147047Update dependencies
0.5.232024-10-1246803Update dependencies
0.5.222024-10-0546449Update dependencies
0.5.212024-09-2846116Update dependencies
0.5.202024-09-2145738Update dependencies
0.5.192024-09-1445483Update dependencies
0.5.182024-09-0745300Update dependencies
0.5.172024-08-3144976Update dependencies
0.5.162024-08-2444651Update dependencies
0.5.152024-08-1744305Update dependencies
0.5.142024-08-1243877Update dependencies
0.5.132024-08-1043574Update dependencies
0.5.122024-08-0343296Update dependencies
0.5.112024-07-2742639Update dependencies
0.5.102024-07-2042318Update dependencies
0.5.92024-07-1341896Update dependencies
0.5.82024-07-1040515Add support for array type custom fields
0.5.72024-07-1041374Update dependencies
0.5.62024-07-0941313Update dependencies
0.5.52024-07-0640994Update dependencies
0.5.42024-06-2540350Update dependencies
0.5.32024-06-2240043Update dependencies
0.5.22024-06-1539477Format source, delete requirements.txt
0.5.12024-05-2038391[autopull] base image + poetry + up_to_date
0.5.02023-11-3032984Add support for custom fields
0.4.32023-10-2831534Fixed Email Activities Stream Pagination
0.4.22023-08-0829206Fixed the issue with DatePicker format for start date
0.4.12023-07-0427950Add human readable titles to API Key and Start Date fields
0.4.02023-06-2727776Update the Email Followup Tasks stream schema
0.3.02023-05-1226024Update the Email sequences stream schema
0.2.22023-05-0525868Added CDK TypeTransformer to gurantee JSON Schema types, added missing properties for roles stream
0.2.12023-02-1523074Specified date formatting in specification
0.2.02022-11-0418968Migrate to Low-Code
0.1.02021-08-105366Initial release of Close.com connector for Airbyte
</details>