ContextQMD
Back to Airbyte

Notion

docs/integrations/sources/notion.md

2.0.026.1 KB
Original Source

Notion

This page contains the setup guide and reference information for the Notion source connector.

Prerequisites

  • Access to a Notion workspace

Setup guide​

To authenticate the Notion source connector, you need to use one of the following two methods:

  • OAuth2.0 authorization (recommended for Airbyte Cloud)
  • Access Token
<!-- env:cloud -->

:::note For Airbyte Cloud users: We highly recommend using OAuth2.0 authorization to connect to Notion, as this method significantly simplifies the setup process. If you use OAuth2.0 authorization in Airbyte Cloud, you do not need to create and configure a new integration in Notion. Instead, you can proceed straight to setting up the connector in Airbyte. :::

<!-- /env:cloud -->

We have provided a quick setup guide for creating an integration in Notion below. If you would like more detailed information and context on Notion integrations, or experience any difficulties with the integration setup process, please refer to the official Notion documentation.

Step 1: Create an integration in Notion​ and set capabilities

  1. Log in to your Notion workspace and navigate to the My integrations page. Select New integration.

:::note You must be the owner of the Notion workspace to create a new integration associated with it. :::

  1. Enter a Name for your integration. Make sure you have selected the correct workspace from the Associated workspace dropdown menu, and click Submit.
  2. In the navbar, select Capabilities. Check the following capabilities based on your use case:

Step 2: Share pages and acquire authorization credentials

Access Token (Cloud and Open Source)

If you are authenticating via Access Token, you will need to manually share each page you want to sync with Airbyte.

  1. Navigate to the page(s) you want to share with Airbyte. Click the ••• menu at the top right of the page, select Add connections, and choose the integration you created in Step 1.
  2. Once you have selected all the pages to share, you can find and copy the Access Token from the Secrets tab of your Notion integration's page. Then proceed to setting up the connector in Airbyte.
<!-- env:oss -->

OAuth2.0 (Open Source only)

If you are authenticating via OAuth2.0 for Airbyte Open Source, you will need to make your integration public and acquire your Client ID, Client Secret and Access Token.

  1. Navigate to the Distribution tab in your integration page, and toggle the switch to make the integration public.
  2. Fill out the required fields in the Organization information and OAuth Domain & URIs section, then click Submit.
  3. Navigate to the Secrets tab to find your Client ID and Client Secret.
  4. You need to use your integration's authorization URL to set the necessary page permissions and send a request to obtain your Access Token. A thorough explanation of the necessary steps is provided in the official Notion documentation. Once you have your Client ID, Client Secret and Access Token, you are ready to proceed to the next step.
<!-- /env:oss -->

Step 3: Set up the Notion connector in Airbyte

  1. Log in to your Airbyte Cloud account, or navigate to your Airbyte Open Source dashboard.
  2. In the left navigation bar, click Sources. In the top-right corner, click New source.
  3. Find and select Notion from the list of available sources.
  4. Enter a Source name of your choosing.
  5. Choose the method of authentication from the dropdown menu:
<!-- env:cloud -->

Authentication for Airbyte Cloud

  • OAuth2.0 (Recommended): Click Authenticate your Notion account. When the popup appears, click Select pages. Check the pages you want to give Airbyte access to, and click Allow access.
  • Access Token: Copy and paste the Access Token found in the Secrets tab of your private integration's page.
<!-- /env:cloud --> <!-- env:oss -->

Authentication for Airbyte Open Source

  • Access Token: Copy and paste the Access Token found in the Secrets tab of your private integration's page.
  • OAuth2.0: Copy and paste the Client ID, Client Secret and Access Token you acquired after setting up your public integration.
<!-- /env:oss -->
  1. (Optional) You may optionally provide a Start Date using the provided datepicker, or by programmatically entering a UTC date and time in the format: YYYY-MM-DDTHH:mm:ss.SSSZ. When using incremental syncs, only data generated after this date will be replicated. If left blank, Airbyte will set the start date two years from the current date by default.
  2. Click Set up source and wait for the tests to complete.

Supported sync modes

The Notion source connector supports the following sync modes:

StreamFull Refresh (Overwrite/Append)Incremental (Append/Append + Deduped)
Blocks✓✓
Comments✓✓
Data Sources✓✓
Pages✓✓
Users✓

Supported Streams

The Notion source connector supports the following streams:

  • Blocks
  • Comments
  • Data Sources (replaces the former Databases stream as of v4.0.0; in Notion's API version 2025-09-03, a "data source" represents what was previously called a "database" — the table containing pages and properties — while "database" now refers to a container that can hold multiple data sources)
  • Pages
  • Users

Performance considerations

The connector is restricted by Notion request limits. The Notion connector should not run into Notion API limitations under normal usage. Create an issue if you encounter any rate limit issues that are not automatically retried successfully.

Changelog

<details> <summary>Expand to review</summary>
VersionDatePull RequestSubject
4.0.12026-03-1074616Update dependencies
4.0.02026-02-2574017Migrate to Notion API version 2025-09-03: replace databases stream with data_sources, update page parent references, and add new schema fields
3.3.142026-02-2473856Update dependencies
3.3.132026-02-1073032Update dependencies
3.3.122026-02-0672925Add client-side incremental filtering to blocks stream RecordFilter
3.3.112026-01-2071943Update dependencies
3.3.102026-01-1471602Update dependencies
3.3.92025-12-1870534Update dependencies
3.3.82025-11-2569853Update dependencies
3.3.72025-11-2469780Fix bug in current_block_depth
3.3.62025-11-1869375Update dependencies
3.3.52025-10-2968750Update dependencies
3.3.42025-10-2168399Update dependencies
3.3.32025-10-1467801Update dependencies
3.3.22025-10-0767422Update dependencies
3.3.12025-09-3066927Update dependencies
3.3.02025-09-2966734Promoting release candidate 3.3.0-rc.1 to a main version.
3.3.0-rc.12025-09-2566532Migrate to manifest-only.
3.2.02025-09-2566695Promoting release candidate 3.2.0-rc.4 to a main version.
3.2.0-rc.42025-09-2466664Handle 404 error and add sequence_number for blocks stream
3.2.0-rc.32025-09-1966539Add default start date if not provided in the config to custom component
3.2.0-rc.22025-09-1966530Add default start date if not provided in the config
3.2.0-rc.12025-09-1866191Migrate Blocks stream to manifest.
3.1.02025-07-3055725Add sequence_number to fetched Notion blocks
3.0.162025-07-2864102Promoting release candidate 3.0.16-rc.1 to a main version.
3.0.16-rc.12025-07-2163368Migrate to CDK V6
3.0.152025-07-1963382Update dependencies
3.0.142025-07-1263213Update dependencies
3.0.132025-07-0562609Update dependencies
3.0.122025-06-2462033Add "in_trash" field in Notion "Pages" endpoint schema
3.0.112025-06-2862356Update dependencies
3.0.102025-06-2161902Update dependencies
3.0.92025-06-1461602Update dependencies
3.0.82025-06-0752290Update dependencies
3.0.72025-01-1143832Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
3.0.62024-06-2540498Fix Pydantic error - add missing type annotation for max_cursor_time
3.0.52024-06-0438871Refactor: use client_side_incremental feature
3.0.42024-06-0638798Implement CheckpointMixin for state handling
3.0.32024-06-0639204[autopull] Upgrade base image to v1.2.2
3.0.22024-05-2038266Replace AirbyteLogger with logging.Logger
3.0.12024-04-2436653Schema descriptions and CDK 0.80.0
3.0.02024-04-1235974Migrate to low-code CDK (python CDK for Blocks stream)
2.2.02024-04-0836890Unpin CDK version
2.1.02024-02-1935409Update users stream schema with bot type info fields and block schema with mention type info fields.
2.0.92024-02-1235155Manage dependencies with Poetry.
2.0.82023-11-0131899Fix table_row.cells property in Blocks stream
2.0.72023-10-3132004Reduce page_size on 504 errors
2.0.62023-10-2531825Increase max_retries on retryable errors
2.0.52023-10-2331742Add 'synced_block' property to Blocks schema
2.0.42023-10-1931625Fix check_connection method
2.0.32023-10-1931612Add exponential backoff for 500 errors
2.0.22023-10-1931599Base image migration: remove Dockerfile and use the python-connector-base image
2.0.12023-10-1731507Add start_date validation checks
2.0.02023-10-0930587Source-wide schema update
1.3.02023-10-0930324Add Comments stream
1.2.22023-10-0930780Update Start Date in config to optional field
1.2.12023-10-0830750Add availability strategy
1.2.02023-10-0431053Add undeclared fields for blocks and pages streams
1.1.22023-08-3029999Update error handling during connection check
1.1.12023-06-1426535Migrate from deprecated authSpecification to advancedAuth
1.1.02023-06-0827170Fix typo in blocks schema
1.0.92023-06-0827062Skip streams with invalid_start_cursor error
1.0.82023-06-0727073Add empty results handling for stream Blocks
1.0.72023-06-0627060Add skipping 404 error in Blocks stream
1.0.62023-05-1826286Add parent field to Blocks stream
1.0.52023-05-0125709Fixed ai_block is unsupported by API issue, while fetching Blocks stream
1.0.42023-04-1125041Improve error handling for API /search
1.0.32023-03-0222931Specified date formatting in specification
1.0.22023-02-2423437Add retry for 400 error (validation_error)
1.0.12023-01-2722018Set AvailabilityStrategy for streams explicitly to None
1.0.02022-12-1920639Fix Pages stream schema
0.1.102022-09-2817298Use "Retry-After" header for backoff
0.1.92022-09-1616799Migrate to per-stream state
0.1.82022-09-0516272Update spec description to include working timestamp example
0.1.72022-07-2615042Update additionalProperties field to true from shared schemas
0.1.62022-07-2114924Remove additionalProperties field from schemas and spec
0.1.52022-07-1414706Added OAuth2.0 authentication
0.1.42022-07-0714505Fixed bug when normalization didn't run through
0.1.32022-04-2211452Use pagination for User stream
0.1.22022-01-119084Fix documentation URL
0.1.12021-12-309207Update connector fields title/description
0.1.02021-10-177092Initial Release
</details>