9cba95d6be
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com> Co-authored-by: pnilan <patrick.nilan@airbyte.io> Co-authored-by: Patrick Nilan <nilan.patrick@gmail.com>
201 lines
6.7 KiB
Markdown
201 lines
6.7 KiB
Markdown
# HubSpot Migration Guide
|
|
|
|
## Upgrading to 6.0.0
|
|
|
|
:::note
|
|
This change is only breaking if you are syncing the `marketing_emails` stream.
|
|
:::
|
|
|
|
This update migrates the `marketing_emails` stream from HubSpot's deprecated v1 API to the new v3 API. While this migration significantly changes the schema of the stream, removing many fields that were previously present, it also enables incremental sync support for the stream. Users will need to refresh the source schema and reset the `marketing_emails` stream after upgrading. Please refer to HubSpot's [`marketing_emails` API documentation](https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2F) for more information on the changes to the endpoint and schema.
|
|
|
|
Users should:
|
|
|
|
- Refresh the source schema for the `marketing_email` stream.
|
|
- Reset the stream after upgrading to ensure uninterrupted syncs.
|
|
|
|
### Refresh affected schemas and reset data
|
|
|
|
1. Select **Connections** in the main nav bar.
|
|
1. Select the connection affected by the update.
|
|
2. Select the **Schema** tab.
|
|
1. Select **Refresh source schema**.
|
|
2. Select **OK**.
|
|
|
|
:::note
|
|
Any detected schema changes will be listed for your review.
|
|
:::
|
|
|
|
3. Select **Save changes** at the top right of the page.
|
|
1. Ensure the **Reset affected streams** option is checked.
|
|
|
|
:::note
|
|
Depending on destination type you may not be prompted to reset your data.
|
|
:::
|
|
|
|
4. Select **Save connection**.
|
|
|
|
:::note
|
|
This will reset the data in your destination and initiate a fresh sync.
|
|
:::
|
|
|
|
For more information on resetting your data in Airbyte, see [this page](/platform/operator-guides/clear)
|
|
|
|
## Upgrading to 5.0.0
|
|
|
|
:::note
|
|
This change is only breaking if you are syncing streams `Contact Lists`, `Contacts Form Submissions`, `Contacts List Memberships`, or `Contacts Merged Audit`.
|
|
:::
|
|
|
|
This update deprecates three contacts streams because Hubspot is deprecating V1 of their REST API and these
|
|
streams make use of data from endpoints that no longer exist in their V3 API.
|
|
|
|
In addition, the certain schema fields of the Contact Lists stream will be added, removed, or modified due to
|
|
changes in how Hubspot's V3 API in comparison to the V1 API being deprecated.
|
|
|
|
Users should:
|
|
|
|
- Refresh the source schema
|
|
- Remove the aforementioned streams from their connection.
|
|
- If applicable, users can enable the `Form Submissions` stream which provides similar functionality to `Contacts Form Submissions`.
|
|
|
|
### Remove deprecated streams, refresh affected schemas, and reset data
|
|
|
|
1. Select **Connections** in the main nav bar.
|
|
1. Select the connection affected by the update.
|
|
2. Select the **Schema** tab.
|
|
1. Select **Refresh source schema**.
|
|
2. Select **OK**.
|
|
|
|
:::note
|
|
Any detected schema changes will be listed for your review.
|
|
:::
|
|
|
|
3. Select **Save changes** at the top right of the page.
|
|
1. Ensure the **Reset affected streams** option is checked.
|
|
|
|
:::note
|
|
Depending on destination type you may not be prompted to reset your data.
|
|
:::
|
|
|
|
4. Select **Save connection**.
|
|
|
|
:::note
|
|
This will reset the data in your destination and initiate a fresh sync.
|
|
:::
|
|
|
|
For more information on resetting your data in Airbyte, see [this page](/platform/operator-guides/clear)
|
|
|
|
## Upgrading to 4.0.0
|
|
|
|
:::note
|
|
This change is only breaking if you are syncing streams `Deals Property History` or `Companies Peoperty History`.
|
|
:::
|
|
|
|
This update brings extended schema with data type changes for the Marketing Emails stream.
|
|
|
|
Users should:
|
|
|
|
- Refresh the source schema for the Marketing Emails stream.
|
|
- Reset the stream after upgrading to ensure uninterrupted syncs.
|
|
|
|
### Refresh affected schemas and reset data
|
|
|
|
1. Select **Connections** in the main nav bar.
|
|
1. Select the connection affected by the update.
|
|
2. Select the **Replication** tab.
|
|
1. Select **Refresh source schema**.
|
|
2. Select **OK**.
|
|
|
|
:::note
|
|
Any detected schema changes will be listed for your review.
|
|
:::
|
|
|
|
3. Select **Save changes** at the bottom of the page.
|
|
1. Ensure the **Reset affected streams** option is checked.
|
|
|
|
:::note
|
|
Depending on destination type you may not be prompted to reset your data.
|
|
:::
|
|
|
|
4. Select **Save connection**.
|
|
|
|
:::note
|
|
This will reset the data in your destination and initiate a fresh sync.
|
|
:::
|
|
|
|
For more information on resetting your data in Airbyte, see [this page](/platform/operator-guides/clear)
|
|
|
|
## Upgrading to 3.0.0
|
|
|
|
:::note
|
|
This change is only breaking if you are syncing the Marketing Emails stream.
|
|
:::
|
|
|
|
This update brings extended schema with data type changes for the Marketing Emails stream.
|
|
|
|
Users should:
|
|
|
|
- Refresh the source schema for the Marketing Emails stream.
|
|
- Reset the stream after upgrading to ensure uninterrupted syncs.
|
|
|
|
### Refresh affected schemas and reset data
|
|
|
|
1. Select **Connections** in the main nav bar.
|
|
1. Select the connection affected by the update.
|
|
2. Select the **Replication** tab.
|
|
1. Select **Refresh source schema**.
|
|
2. Select **OK**.
|
|
|
|
:::note
|
|
Any detected schema changes will be listed for your review.
|
|
:::
|
|
|
|
3. Select **Save changes** at the bottom of the page.
|
|
1. Ensure the **Reset affected streams** option is checked.
|
|
|
|
:::note
|
|
Depending on destination type you may not be prompted to reset your data.
|
|
:::
|
|
|
|
4. Select **Save connection**.
|
|
|
|
:::note
|
|
This will reset the data in your destination and initiate a fresh sync.
|
|
:::
|
|
|
|
For more information on resetting your data in Airbyte, see [this page](/platform/operator-guides/clear)
|
|
|
|
## Upgrading to 2.0.0
|
|
|
|
:::note
|
|
This change is only breaking if you are syncing the Property History stream.
|
|
:::
|
|
|
|
With this update, you can now access historical property changes for Deals and Companies, in addition to Contacts. To facilitate this change, the Property History stream has been renamed to Contacts Property History (since it contained historical property changes from Contacts) and two new streams have been added: Deals Property History and Companies Property History.
|
|
|
|
This constitutes a breaking change as the Property History stream has been deprecated and replaced with the Contacts Property History. Please follow the instructions below to migrate to version 2.0.0:
|
|
|
|
1. Select **Connections** in the main navbar.
|
|
1. Select the connection(s) affected by the update.
|
|
2. Select the **Replication** tab.
|
|
1. Select **Refresh source schema**.
|
|
|
|
:::note
|
|
Any detected schema changes will be listed for your review. Select **OK** to proceed.
|
|
:::
|
|
|
|
3. Select **Save changes** at the bottom of the page.
|
|
1. Ensure the **Reset affected streams** option is checked.
|
|
|
|
:::note
|
|
Depending on destination type you may not be prompted to reset your data
|
|
:::
|
|
|
|
4. Select **Save connection**.
|
|
|
|
:::note
|
|
This will reset the data in your destination and initiate a fresh sync.
|
|
:::
|
|
|
|
For more information on resetting your data in Airbyte, see [this page](/platform/operator-guides/clear).
|