Notion authentication

This page documents the authentication and configuration options for the Notion agent connector.

Authentication

Open source execution

In open source mode, you provide API credentials directly to the connector.

OAuth

credentials fields you need:

Field Name	Type	Required	Description
client_id	str	Yes	Your Notion OAuth integration's client ID
client_secret	str	Yes	Your Notion OAuth integration's client secret
access_token	str	Yes	OAuth access token obtained through the Notion authorization flow

Example request:

from airbyte_agent_notion import NotionConnector
from airbyte_agent_notion.models import NotionOauth20AuthConfig

connector = NotionConnector(
    auth_config=NotionOauth20AuthConfig(
        client_id="<Your Notion OAuth integration's client ID>",
        client_secret="<Your Notion OAuth integration's client secret>",
        access_token="<OAuth access token obtained through the Notion authorization flow>"
    )
)

Token

credentials fields you need:

Field Name	Type	Required	Description
token	str	Yes	Notion internal integration token (starts with ntn_ or secret_)

Example request:

from airbyte_agent_notion import NotionConnector
from airbyte_agent_notion.models import NotionAccessTokenAuthConfig

connector = NotionConnector(
    auth_config=NotionAccessTokenAuthConfig(
        token="<Notion internal integration token (starts with ntn_ or secret_)>"
    )
)

Hosted execution

In hosted mode, you first create a connector via the Airbyte API (providing your OAuth or Token credentials), then execute operations using either the Python SDK or API. If you need a step-by-step guide, see the hosted execution tutorial.

OAuth

Create a connector with OAuth credentials.

credentials fields you need:

Field Name	Type	Required	Description
client_id	str	Yes	Your Notion OAuth integration's client ID
client_secret	str	Yes	Your Notion OAuth integration's client secret
access_token	str	Yes	OAuth access token obtained through the Notion authorization flow

Example request:

curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_name": "<CUSTOMER_NAME>",
    "connector_type": "Notion",
    "name": "My Notion Connector",
    "credentials": {
      "client_id": "<Your Notion OAuth integration's client ID>",
      "client_secret": "<Your Notion OAuth integration's client secret>",
      "access_token": "<OAuth access token obtained through the Notion authorization flow>"
    }
  }'

Bring your own OAuth flow

To implement your own OAuth flow, use Airbyte's server-side OAuth API endpoints. For a complete guide, see Build your own OAuth flow.

Configure your own OAuth app credentials (optional)

By default, Airbyte uses its own OAuth app credentials. You can override these with your own so that OAuth consent screens show your company's branding. If you skip this step, the consent screen shows "Airbyte" as the requesting application.

Python SDK

from airbyte_agent_notion import NotionConnector, AirbyteAuthConfig
from airbyte_agent_notion.models import NotionOAuthCredentials

await NotionConnector.configure_oauth_app_parameters(
    airbyte_config=AirbyteAuthConfig(
        airbyte_client_id="<your_airbyte_client_id>",
        airbyte_client_secret="<your_airbyte_client_secret>",
    ),
    credentials=NotionOAuthCredentials(
        client_id="<Your Notion OAuth integration's client ID>",
        client_secret="<Your Notion OAuth integration's client secret>",
    ),
)

API

curl -X PUT "https://api.airbyte.ai/api/v1/oauth/credentials" \
  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "connector_type": "notion",
    "configuration": {
      "client_id": "<Your Notion OAuth integration's client ID>",
      "client_secret": "<Your Notion OAuth integration's client secret>"
    }
  }'

To revert to Airbyte-managed defaults:

Python SDK

await NotionConnector.configure_oauth_app_parameters(
    airbyte_config=AirbyteAuthConfig(
        airbyte_client_id="<your_airbyte_client_id>",
        airbyte_client_secret="<your_airbyte_client_secret>",
    ),
    credentials=None,
)

API

curl -X DELETE "https://api.airbyte.ai/api/v1/oauth/credentials/connector_type/notion" \
  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>"

Step 1: Initiate the OAuth flow

Request a consent URL for your user.

Field Name	Type	Required	Description
customer_name	string	Yes	Your unique identifier for the customer
connector_type	string	Yes	The connector type (e.g., "Notion")
redirect_url	string	Yes	URL to redirect to after OAuth authorization

Example request:

curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors/oauth/initiate" \
  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_name": "<CUSTOMER_NAME>",
    "connector_type": "Notion",
    "redirect_url": "https://yourapp.com/oauth/callback"
  }'

Redirect your user to the consent_url from the response.

Step 2: Handle the callback

After the user authorizes access, Airbyte automatically creates the connector and redirects them to your redirect_url with a connector_id query parameter. You don't need to make a separate API call to create the connector.

https://yourapp.com/oauth/callback?connector_id=<connector_id>

Extract the connector_id from the callback URL and store it for future operations. For error handling and a complete implementation example, see Build your own OAuth flow.

Token

Create a connector with Token credentials.

credentials fields you need:

Field Name	Type	Required	Description
token	str	Yes	Notion internal integration token (starts with ntn_ or secret_)

Example request:

curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_name": "<CUSTOMER_NAME>",
    "connector_type": "Notion",
    "name": "My Notion Connector",
    "credentials": {
      "token": "<Notion internal integration token (starts with ntn_ or secret_)>"
    }
  }'

Execution

After creating the connector, execute operations using either the Python SDK or API. If your Airbyte client can access multiple organizations, include organization_id in AirbyteAuthConfig and X-Organization-Id in raw API calls.

Python SDK

from airbyte_agent_notion import NotionConnector, AirbyteAuthConfig

connector = NotionConnector(
    auth_config=AirbyteAuthConfig(
        customer_name="<your_customer_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@NotionConnector.tool_utils
async def notion_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

API

curl -X POST 'https://api.airbyte.ai/api/v1/integrations/connectors/<connector_id>/execute' \
  -H 'Authorization: Bearer <YOUR_BEARER_TOKEN>' \
  -H 'X-Organization-Id: <YOUR_ORGANIZATION_ID>' \
  -H 'Content-Type: application/json' \
  -d '{"entity": "<entity>", "action": "<action>", "params": {}}'