Skip to content

Commit 3bddf87

Browse files
lazebnyilazebnyi
authored
Refactored docs (#13306)
1 parent da88158 commit 3bddf87

File tree

1 file changed

+59
-75
lines changed

1 file changed

+59
-75
lines changed

‎docs/integrations/sources/hubspot.md

+59-75
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,62 @@
11
# HubSpot
22

3-
## Features
3+
This page contains the setup guide and reference information for the HubSpot source connector.
4+
5+
## Prerequisites
6+
7+
Chose `start date` which is any data before this date will not be replicated and should be UTC date and time in the format 2017-01-25T00:00:00Z.
8+
9+
## Setup guide
10+
### Step 1: Set up HubSpot
11+
12+
If you are using OAuth, most of the streams require the appropriate [scopes](https://legacydocs.hubspot.com/docs/methods/oauth2/initiate-oauth-integration#scopes) enabled for the API account.
13+
14+
| Stream | Required Scope |
15+
| :--- | :--- |
16+
| `campaigns` | `content` |
17+
| `companies` | `contacts` |
18+
| `contact_lists` | `contacts` |
19+
| `contacts` | `contacts` |
20+
| `contacts_list_memberships` | `contacts` |
21+
| `deal_pipelines` | either the `contacts` scope \(to fetch deals pipelines\) or the `tickets` scope. |
22+
| `deals` | `contacts` |
23+
| `email_events` | `content` |
24+
| `engagements` | `contacts` |
25+
| `engagements_emails` | `sales-email-read` |
26+
| `feedback_submissions` | `crm.objects.feedback_submissions.read` |
27+
| `forms` | `forms` |
28+
| `form_submissions`| `forms` |
29+
| `line_items` | `e-commerce` |
30+
| `owners` | `contacts` |
31+
| `products` | `e-commerce` |
32+
| `property_history` | `contacts` |
33+
| `quotes` | no scope required |
34+
| `subscription_changes` | `content` |
35+
| `tickets` | `tickets` |
36+
| `workflows` | `automation` |
37+
38+
39+
## Step 2: Set up the HubSpot connector in Airbyte
40+
41+
### For Airbyte Cloud:
42+
1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account.
43+
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
44+
3. On the Set up the source page, enter the name for the HubSpot connector and select **HubSpot** from the Source type dropdown.
45+
4. Click `Authenticate your account` to sign in with Google and authorize your account.
46+
5. Fill out a `start date`.
47+
6. You're done.
48+
49+
### For Airbyte OSS:
50+
1. Fill out a `API Key`.
51+
2. Fill out a `start date`.
52+
3. You're done.
53+
54+
To obtain the 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, generate a new one. See [docs](https://knowledge.hubspot.com/integrations/how-do-i-get-my-hubspot-api-key) for more details.
55+
56+
57+
## Supported sync modes
58+
59+
The HubSpot source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
460

561
| Feature | Supported? |
662
| :--- | :--- |
@@ -9,14 +65,8 @@
965
| Replicate Incremental Deletes | No |
1066
| SSL connection | Yes |
1167

12-
## Troubleshooting
13-
14-
Check out common troubleshooting issues for the HubSpot connector on our Discourse [here](https://discuss.airbyte.io/tags/c/connector/11/source-hubspot).
15-
1668
## Supported Streams
1769

18-
This source is capable of syncing the following tables and their data:
19-
2070
* [Campaigns](https://developers.hubspot.com/docs/methods/email/get_campaign_data)
2171
* [Companies](https://developers.hubspot.com/docs/api/crm/companies) \(Incremental\)
2272
* [Contact Lists](http://developers.hubspot.com/docs/methods/lists/get_lists) \(Incremental\)
@@ -59,47 +109,7 @@ Depending on the type of engagement, different properties will be set for that o
59109

60110
**Note**: HubSpot API currently only supports `quotes` endpoint using API Key, using OAuth it is impossible to access this stream (as reported by [community.hubspot.com](https://community.hubspot.com/t5/APIs-Integrations/Help-with-using-Feedback-CRM-API-and-Quotes-CRM-API/m-p/449104/highlight/true#M44411)).
61111

62-
## Getting Started
63-
64-
### Requirements \(Airbyte Cloud\)
65-
66-
1. Click `Authenticate your account` to sign in with Google and authorize your account.
67-
2. Fill out a start date
68-
3. You're done.
69-
70-
:::info
71-
72-
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.
73-
74-
:::
75-
76-
### Requirements \(Airbyte Open-Source\)
77-
78-
* HubSpot Account
79-
* API or OAuth2.0 Credentials (See below)
80-
81-
#### Using API Credentials
82-
83-
* API Key
84-
85-
To obtain the 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, generate a new one. See [docs](https://knowledge.hubspot.com/integrations/how-do-i-get-my-hubspot-api-key) for more details.
86-
87-
#### Using OAuth2.0 Credentials
88-
89-
* Client ID
90-
* Client Secret
91-
* Refresh Token
92-
* If using OAuth, [scopes](https://legacydocs.hubspot.com/docs/methods/oauth2/initiate-oauth-integration#scopes) enabled for the streams you want to sync
93-
94-
See HubSpot [docs](https://legacydocs.hubspot.com/docs/methods/oauth2/oauth2-quickstart) if you need help finding these fields
95-
96-
:::info
97-
98-
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.
99-
100-
:::
101-
102-
## Rate Limiting & Performance
112+
## Performance considerations
103113

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

@@ -117,33 +127,7 @@ Example of the output message when trying to read `workflows` stream with missin
117127
}
118128
```
119129

120-
## Required scopes
121-
122-
If you are using OAuth, most of the streams require the appropriate [scopes](https://legacydocs.hubspot.com/docs/methods/oauth2/initiate-oauth-integration#scopes) enabled for the API account.
123-
124-
| Stream | Required Scope |
125-
| :--- | :--- |
126-
| `campaigns` | `content` |
127-
| `companies` | `contacts` |
128-
| `contact_lists` | `contacts` |
129-
| `contacts` | `contacts` |
130-
| `contacts_list_memberships` | `contacts` |
131-
| `deal_pipelines` | either the `contacts` scope \(to fetch deals pipelines\) or the `tickets` scope. |
132-
| `deals` | `contacts` |
133-
| `email_events` | `content` |
134-
| `engagements` | `contacts` |
135-
| `engagements_emails` | `sales-email-read` |
136-
| `feedback_submissions` | `crm.objects.feedback_submissions.read` |
137-
| `forms` | `forms` |
138-
| `form_submissions`| `forms` |
139-
| `line_items` | `e-commerce` |
140-
| `owners` | `contacts` |
141-
| `products` | `e-commerce` |
142-
| `property_history` | `contacts` |
143-
| `quotes` | no scope required |
144-
| `subscription_changes` | `content` |
145-
| `tickets` | `tickets` |
146-
| `workflows` | `automation` |
130+
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.
147131

148132
## Changelog
149133

0 commit comments

Comments
 (0)