Skip to main content

Notion Migration Guide

Availability:
Available Airbyte CloudAvailable Airbyte OSSAvailable PyAirbyte
Support Level:
Airbyte Connector
Connector Version:
3.0.6(Last updated 3 months ago)
CDK Version:
1.5.1
Sync Success Rate:
Usage Rate:

We're continuously striving to enhance the quality and reliability of our connectors at Airbyte. As part of our commitment to delivering exceptional service, we are transitioning source Notion from the Python Connector Development Kit (CDK) to our innovative low-code framework. This is part of a strategic move to streamline many processes across connectors, bolstering maintainability and freeing us to focus more of our efforts on improving the performance and features of our evolving platform and growing catalog. However, due to differences between the Python and low-code CDKs, this migration constitutes a breaking change for users syncing data from the Comments stream.

Specifically, we’ve evolved and standardized how state is managed for incremental streams that are nested within a parent stream. This change impacts how individual states are tracked and stored for each partition, using a more structured approach to ensure the most granular and flexible state management. To gracefully handle these changes for your existing connections, we highly recommend clearing your data for the Comments stream before resuming your syncs with the new version.

If you are not syncing data from the Comments stream, this change is non-breaking, and no further action is required.

Data for the Comments stream will need to cleared to ensure your syncs continue successfully. To clear your data for the Comments stream, follow the steps below:

  1. Select Connections in the main nav bar.
    1. Select the connection(s) affected by the update.
  2. Select the Status tab.
    1. In the Enabled streams list, click the three dots on the right side of the Comments stream and select Clear data.

After the clear succeeds, trigger a sync for the Comments stream by clicking "Sync Now". For more information on clearing your data in Airbyte, see this page.

Version 2.0.0 introduces a number of changes to the JSON schemas of all streams. These changes are being introduced to reflect updates to the Notion API. Some breaking changes have been introduced that will affect the Blocks, Databases and Pages stream.

  • The type of the rich_text property in the Pages stream has been updated from an object to an array of rich_text objects
  • The type of the phone_number property in the Pages stream has been updated from a string to an object
  • The deprecated text property in content blocks has been renamed to rich_text. This change affects the Blocks, Databases and Pages streams.

A full schema refresh and data reset are required when upgrading to this version.

Was this page helpful?