Connecting to Notion
To authenticate to Notion, you can use the OAuth standard to connect to your own data or to allow other users to connect to their data. Alternatively, you can use an Integration Token (APIKey) for internal integrations.
Using OAuth Authentication
First you will need to create an OAuth integration. To do so, navigate to https://www.notion.so/my-integrations and click "New integration". Select "Public integration" to enable OAuth. Configure your integration with a name and workspace, then navigate to the "OAuth Domain & URIs" section. Add your redirect URI (this will be your CallbackUrl). The OAuth client ID and OAuth client secret from the "Secrets" section will be your OAuthClientId and OAuthClientSecret.
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to OAuth.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
- OAuthClientId: Set this to the OAuth client ID that is specified in your integration settings.
- OAuthClientSecret: Set this to the OAuth client secret that is specified in your integration settings.
- CallbackURL: Set this to the redirect URI you specified in your integration settings.
Example Connection String
Profile=Notion.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
Using APIKey Authentication
To use an Integration Token (Internal Integration), create an internal integration at https://www.notion.so/my-integrations. Click "New integration" and configure it with a name and workspace. After creating the integration, copy the "Internal Integration Token" from the "Secrets" section. You will need to share your Notion pages and databases with this integration to grant it access.
After obtaining your Integration Token, set the following connection properties:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Integration Token in the ProfileSettings property.
Example Connection String
Profile=Notion.apip;ProfileSettings='APIKey=your_integration_token';Authscheme=APIKey;
Connection Properties
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.
| Property | Description |
| APIKey | Your Notion Integration Token (Internal Integration). |
| AuthScheme | The scheme used for authentication. Accepted entries are OAuth or APIKey. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT |
| CallbackURL | Identifies the URL users return to after authenticating to API via OAuth (Custom OAuth applications only). |
| InitiateOAuth | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. Allowed values are: OFF, REFRESH, GETANDREFRESH |
| OAuthAccessToken | Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthRefreshToken | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthSettingsLocation | Specifies the location of the settings file where OAuth values are saved. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
| OAuthVerifier | Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |