🎉 New source: Native Hubspot connector (#2215)
* #2150 Issue: created native connector with schema folder populated * #2150 Issue: make format code * first version * fix few issues * fix issues * fix read issue * format * docs * docker tags * extend configured catalog for testing * fix source definitions * format * fix call rate issue, add backoff for retry after * add general backoff * write secrets for new connector * drop singer connector registration * refactor streams, resolve properties in schemas at runtime * replace deprecated endpoint for company contacts * replace deprecated pipeline endpoint * update comments * update docs * fix typo * fix stream contact lists * fix pagination and forms result fetching * fix health_check * format and update catalog * revert changes * drop singer based hubspot * fix company contacts substream * move deals to separate test * fix deals tests * remove dynamic fields from records * move deals to catalog again * extend CRMObjectStream with associations * format * update schemas with updated field, change engagement layout * fix Campaign stream * remove custom tests * remove dependency * remove oauth * Source Hubspot: add incremental streams (#2425) * add incremental * add incremental * polishing * update docs * fix docstring * clean up * fix incremental bookmark access * fix incremental tests * clean up * add custom test for incremental, improve logging * format * Update airbyte-integrations/connectors/source-hubspot/source_hubspot/api.py Co-authored-by: Eugene Kulak <kulak.eugene@gmail.com> Co-authored-by: Sherif A. Nada <snadalive@gmail.com> * Source Hubspot: best practices (#2537) * fix error reporting and add unit tests * fix test and refactor cursor fields * format Co-authored-by: Eugene Kulak <kulak.eugene@gmail.com> * restored configured_catalog.json Co-authored-by: ykurochkin <y.kurochkin@zazmic.com> Co-authored-by: Eugene Kulak <widowmakerreborn@gmail.com> Co-authored-by: Sherif A. Nada <snadalive@gmail.com>
This commit is contained in:
Eugene K
@@ -2,11 +2,27 @@
|
||||
|
||||
## Overview
|
||||
|
||||
The Hubspot connector can be used to sync your Hubspot data. It supports full refresh and incremental sync. It is based on the [Singer Hubspot Tap](https://github.com/singer-io/tap-hubspot).
|
||||
The Hubspot connector can be used to sync your Hubspot data. It supports full refresh sync for all streams and incremental sync for Email Events and Subscription Changes streams.
|
||||
|
||||
### Output schema
|
||||
|
||||
Several output streams are available from this source \(campaigns, contacts, deals, etc.\) For a comprehensive output schema [look at the Singer tap schema files](https://github.com/singer-io/tap-hubspot/tree/master/tap_hubspot/schemas).
|
||||
Several output streams are available from this source:
|
||||
* [Campaigns](https://developers.hubspot.com/docs/methods/email/get_campaign_data)
|
||||
* [Companies](https://developers.hubspot.com/docs/api/crm/companies)
|
||||
* [Contact Lists](http://developers.hubspot.com/docs/methods/lists/get_lists)
|
||||
* [Contacts](https://developers.hubspot.com/docs/methods/contacts/get_contacts)
|
||||
* [Deal Pipelines](https://developers.hubspot.com/docs/methods/pipelines/get_pipelines_for_object_type)
|
||||
* [Deals](https://developers.hubspot.com/docs/api/crm/deals)
|
||||
* [Email Events](https://developers.hubspot.com/docs/methods/email/get_events) (Incremental)
|
||||
* [Engagements](https://legacydocs.hubspot.com/docs/methods/engagements/get-all-engagements)
|
||||
* [Forms](https://developers.hubspot.com/docs/api/marketing/forms)
|
||||
* [Line Items](https://developers.hubspot.com/docs/api/crm/line-items)
|
||||
* [Owners](https://developers.hubspot.com/docs/methods/owners/get_owners)
|
||||
* [Products](https://developers.hubspot.com/docs/api/crm/products)
|
||||
* [Quotes](https://developers.hubspot.com/docs/api/crm/quotes)
|
||||
* [Subscription Changes](https://developers.hubspot.com/docs/methods/email/get_subscriptions_timeline) (Incremental)
|
||||
* [Tickets](https://developers.hubspot.com/docs/api/crm/tickets)
|
||||
* [Workflows](https://legacydocs.hubspot.com/docs/methods/workflows/v3/get_workflows)
|
||||
|
||||
### Features
|
||||
|
||||
@@ -14,7 +30,7 @@ Several output streams are available from this source \(campaigns, contacts, dea
|
||||
| :--- | :--- |
|
||||
| Full Refresh Sync | Yes |
|
||||
| Incremental Sync | Yes |
|
||||
| Replicate Incremental Deletes | Coming soon |
|
||||
| Replicate Incremental Deletes | No |
|
||||
| SSL connection | Yes |
|
||||
|
||||
### Performance considerations
|
||||
@@ -30,9 +46,7 @@ The connector is restricted by normal Hubspot [rate limitations](https://legacyd
|
||||
|
||||
### Setup guide
|
||||
|
||||
\*There are two ways of performing auth with hubspot \(api key and oauth\):
|
||||
|
||||
* For api key auth, in Hubspot, for the account to go settings -> integrations \(under the account banner\) -> api key. If you already have an api key you can use that. Otherwise generated a new one.
|
||||
* Note: The Hubspot [docs](https://legacydocs.hubspot.com/docs/methods/auth/oauth-overview) recommends that api key auth is only used for testing purposes.
|
||||
* For oauth follow the [oauth instruction](https://developers.hubspot.com/docs/api/oauth-quickstart-guide) in Hubspot to get client\_id, client\_secret, redirect\_uri, and refresh\_token.
|
||||
|
||||
This connector supports only authentication with API Key.
|
||||
To obtain API key for the account go to settings -> integrations \(under the account banner\) -> api key.
|
||||
If you already have an api key you can use that. Otherwise generated a new one.
|
||||
See [docs](https://knowledge.hubspot.com/integrations/how-do-i-get-my-hubspot-api-key) for more details.
|
||||
|
||||
Reference in New Issue
Block a user