Skip to main content

Notion

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

Setup guide​​

Step 1: Set up Notion​​

  1. Create a new integration on the My integrations page.
note

You must be the owner of a Notion workspace to create a new integration.

  1. Fill out the form. Make sure to check Read content and check any other capabilities you want to authorize.
  2. Click Submit.
  3. In the Integration type section, select either Internal integration (token authorization) or Public integration (OAuth2.0 authentication).
  4. Check the capabilities you want to authorize.
  5. If you select Public integration, fill out the fields in the OAuth Domain & URIs section.
  6. Click Save changes.
  7. Copy the Internal Access Token if you are using the internal integration, or copy the access_token, client_id, and client_secret if you are using the public integration.

Step 2: Set up the Notion connector in Airbyte​

For Airbyte Cloud:

  1. Log in to your Airbyte Cloud account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Notion from the Source type dropdown.
  4. Enter a name for your source.
  5. Choose the method of authentication:
    • If you select Access Token, paste the access token from Step 8.
    • If you select OAuth2.0 authorization, click Authenticate your Notion account.
      • Log in and Authorize the Notion account. Select the permissions you want to allow Airbyte.
  6. Enter the Start Date in YYYY-MM-DDTHH:mm:ssZ format. All data generated after this date will be replicated. If this field is blank, Airbyte will replicate all data.
  7. Click Set up source.

For Airbyte Open Source:

  1. Log in to your Airbyte Open Source account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Notion from the Source type dropdown.
  4. Enter a name for your source.
  5. Choose the method of authentication:
    • If you select Access Token, paste the access token from Step 8.
    • If you select OAuth2.0 authorization, paste the client ID, access token, and client secret from Step 8.
  6. Enter the Start Date in YYYY-MM-DDTHH:mm:ssZ format. All data generated after this date will be replicated. If this field is blank, Airbyte will replicate all data.
  7. Click Set up source.

Supported sync modes​

The Notion source connector supports the following sync modes:

Supported Streams​

The Notion source connector supports the following streams. For more information, see the Notion API.

note

The users stream does not support Incremental - Append sync mode.

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​

VersionDatePull RequestSubject
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