1
0
mirror of synced 2026-01-04 09:04:47 -05:00
Files
airbyte/docs/integrations/sources/close-com.md
Sophia Wiley 5512befeb1 Docs: updated links from .io to .com (#23652)
* updated links

* edited contributors link

* deleted line about CDK in docs
2023-03-06 17:27:55 +01:00

6.4 KiB

Close.com

Prerequisites

  • Close.com Account
  • Close.com API Key

Visit the Close.com API Keys page in the Close.com dashboard to access the secret key for your account. Secret key will be prefixed with api_. See this guide if you need to create a new one.

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

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click +new source.
  3. On the Set up the source page, enter the name for the Close.com connector and select Close.com from the Source type dropdown.
  4. Fill in the API Key and Start date fields and click Set up source.

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 or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.

Supported Streams

This Source is capable of syncing the following core Streams:

Notes

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

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 has rate limit. There are 60 RPS for Organizations. You can find detailed info here.

Changelog

Version Date Pull Request Subject
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