Skip to main content
For the complete documentation index for agents and LLMs, see llms.txt.

Set Up OAuth for NotionBeta

Beta
This is coming — this page describes a feature that's still being rolled out and may not be available to you yet.

Register Notion as an OAuth provider so users can authorize Notion workspace access from Haystack Enterprise Platform.


About This Task​

The Notion template uses Notion's public OAuth endpoints. Notion integrations declare capabilities when you create the integration; scopes in Haystack Enterprise Platform should match the access you configured in Notion.

Prerequisites​

Redirect URL

Register the redirect URI from the Redirect URL field in the Add OAuth Provider dialog with your identity provider. Keep the default unless you embed the connect flow in your own frontend.

The callback is served by the deepset API, not the web app. On deepset Cloud, the default is https://api.cloud.deepset.ai/api/v2/connections/callback. On other deployments, use your organization's API base URL with the path /api/v2/connections/callback.

Create a Notion Integration​

  1. Open Notion: My integrations and click New integration.
  2. Type a name, select the associated workspace, and choose the capabilities your use case needs.
  3. Open the integration settings and go to the OAuth section.
  4. Add the redirect URI from Haystack Enterprise Platform to the list of authorized redirect URIs.
  5. Copy the OAuth client ID and OAuth client secret (sometimes labeled Client ID and Client secret).

For details, see Notion authorization.

Register the Provider in Haystack Enterprise Platform​

  1. Click your profile icon and choose Settings.
  2. Go to Organization and open Integrations.
  3. In External Connections, click Add OAuth Provider.
  4. Select the Notion template.
  5. Fill in the fields:
    • Provider Type — keep notion unless you register multiple Notion integrations.
    • Display Name — for example Notion. Choose a name that will make it easy for users to identify the provider.
    • Client ID and Client Secret from the Notion integration.
    • Authorization URL and Token URL — pre-filled to Notion's OAuth endpoints.
    • Scopes — add scopes if your integration requires them beyond the Notion integration capabilities. Default scopes include read and write access to the Notion workspace. Adjust scopes if your integration needs different permissions.
  6. Click Create.

What To Do Next​