Skip to content

Commit

Permalink
Docs Refresh: Hubspot Source (#6700)
Browse files Browse the repository at this point in the history
  • Loading branch information
avaidyanatha authored Oct 4, 2021
1 parent 770bbf9 commit f3b32e4
Showing 1 changed file with 25 additions and 30 deletions.
55 changes: 25 additions & 30 deletions docs/integrations/sources/hubspot.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# Hubspot

## Overview
## Features

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.
| Feature | Supported? |
| :--- | :--- |
| Full Refresh Sync | Yes |
| Incremental Sync | Yes |
| Replicate Incremental Deletes | No |
| SSL connection | Yes |

## Troubleshooting

#### Issue: `414 Client Error: Request-URI Too Large for url` failing sync. [\[Workaround\]](https://discuss.airbyte.io/t/source-hubspot-failed-sync-request-uri-too-large-for-contact-stream/59)

### Output schema
## Supported Tables

Several output streams are available from this source:
This source is capable of syncing the following tables and their data:

* [Campaigns](https://developers.hubspot.com/docs/methods/email/get_campaign_data)
* [Companies](https://developers.hubspot.com/docs/api/crm/companies)
Expand All @@ -25,17 +34,20 @@ Several output streams are available from this source:
* [Tickets](https://developers.hubspot.com/docs/api/crm/tickets)
* [Workflows](https://legacydocs.hubspot.com/docs/methods/workflows/v3/get_workflows)

### Features
## Getting Started (Airbyte Open-Source / Airbyte Cloud)

| Feature | Supported? |
| :--- | :--- |
| Full Refresh Sync | Yes |
| Incremental Sync | Yes |
| Replicate Incremental Deletes | No |
| SSL connection | Yes |
| Namespaces | No |
#### Requirements

### Performance considerations
* Hubspot Account
* Api credentials

{% hint style="info" %}
Hubspot's API will [rate limit](https://developers.hubspot.com/docs/api/usage-details) the amount of records you can sync daily, so make sure that you are on the appropriate plan if you are planning on syncing more than 250,000 records per day.
{% endhint %}

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.

## Rate Limiting & Performance

The connector is restricted by normal Hubspot [rate limitations](https://legacydocs.hubspot.com/apps/api_guidelines).

Expand All @@ -52,23 +64,6 @@ Example of the output message when trying to read `workflows` stream with missin
}
```

## Getting started


### Requirements

* Hubspot Account
* Api credentials

### Setup guide

{% hint style="info" %}
Hubspot's API will [rate limit](https://developers.hubspot.com/docs/api/usage-details) the amount of records you can sync daily, so make sure that you are on the appropriate plan if you are planning on syncing more than 250,000 records per day.
{% endhint %}

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.


## Changelog

| Version | Date | Pull Request | Subject |
Expand Down

0 comments on commit f3b32e4

Please sign in to comment.