docs: add Notion Setup instructions
This commit is contained in:
parent
c540f00d81
commit
425269420e
1 changed files with 78 additions and 0 deletions
78
docs/docs/integrations/notion/notion-setup.md
Normal file
78
docs/docs/integrations/notion/notion-setup.md
Normal file
|
|
@ -0,0 +1,78 @@
|
|||
import Admonition from "@theme/Admonition";
|
||||
|
||||
# Setting up a Notion Integration for Langflow
|
||||
|
||||
To use Notion components in Langflow, you first need to create a Notion integration and configure it with the necessary capabilities. This guide will walk you through the process of setting up a Notion integration and granting it access to your Notion databases.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A Notion account with access to the workspace where you want to use the integration.
|
||||
- Admin permissions in the Notion workspace to create and manage integrations.
|
||||
|
||||
## Step 1: Create a Notion Integration
|
||||
|
||||
1. Go to the [Notion Integrations](https://www.notion.com/my-integrations) page.
|
||||
2. Click on the "New integration" button.
|
||||
3. Give your integration a name and select the workspace where you want to use it.
|
||||
4. Click "Submit" to create the integration.
|
||||
|
||||
<Admonition type="info" title="Integration Capabilities">
|
||||
When creating the integration, make sure to enable the necessary capabilities based on your requirements. Refer to the [Notion Integration Capabilities](https://developers.notion.com/reference/capabilities) documentation for more information on each capability.
|
||||
</Admonition>
|
||||
|
||||
## Step 2: Configure Integration Capabilities
|
||||
|
||||
After creating the integration, you need to configure its capabilities to define what actions it can perform and what data it can access.
|
||||
|
||||
1. In the integration settings page, go to the "Capabilities" tab.
|
||||
2. Enable the required capabilities for your integration. For example:
|
||||
- If your integration needs to read data from Notion, enable the "Read content" capability.
|
||||
- If your integration needs to create new content in Notion, enable the "Insert content" capability.
|
||||
- If your integration needs to update existing content in Notion, enable the "Update content" capability.
|
||||
3. Configure the user information access level based on your integration's requirements.
|
||||
4. Save the changes.
|
||||
|
||||
## Step 3: Obtain Integration Token
|
||||
|
||||
To authenticate your integration with Notion, you need to obtain an integration token.
|
||||
|
||||
1. In the integration settings page, go to the "Secrets" tab.
|
||||
2. Copy the "Internal Integration Token" value. This token will be used to authenticate your integration with Notion.
|
||||
|
||||
<Admonition type="warning" title="Keep Your Token Secure">
|
||||
Your integration token is a sensitive piece of information. Make sure to keep it secure and never share it publicly. Store it safely in your Langflow configuration or environment variables.
|
||||
</Admonition>
|
||||
|
||||
## Step 4: Grant Integration Access to Notion Databases
|
||||
|
||||
For your integration to interact with Notion databases, you need to grant it access to the specific databases it will be working with.
|
||||
|
||||
1. Open the Notion database that you want your integration to access.
|
||||
2. Click on the "Share" button in the top-right corner of the page.
|
||||
3. In the "Invite" section, select your integration from the list.
|
||||
4. Click "Invite" to grant the integration access to the database.
|
||||
|
||||
<Admonition type="info" title="Nested Databases">
|
||||
If your database contains references to other databases, you need to grant the integration access to those referenced databases as well. Repeat step 4 for each referenced database to ensure your integration has the necessary access.
|
||||
</Admonition>
|
||||
|
||||
## Using Notion Components in Langflow
|
||||
|
||||
Once you have set up your Notion integration and granted it access to the required databases, you can start using the Notion components in Langflow.
|
||||
|
||||
Langflow provides the following Notion components:
|
||||
|
||||
- **List Pages**: Retrieves a list of pages from a Notion database.
|
||||
- **List Database Properties**: Retrieves the properties of a Notion database.
|
||||
- **Add Page Content**: Adds content to a Notion page.
|
||||
- **List Users**: Retrieves a list of users with access to a Notion workspace.
|
||||
- **Update Property**: Updates the value of a property in a Notion page.
|
||||
|
||||
Refer to the individual component documentation for more details on how to use each component in your Langflow flows.
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Notion API Documentation](https://developers.notion.com/docs/getting-started)
|
||||
- [Notion Integration Capabilities](https://developers.notion.com/reference/capabilities)
|
||||
|
||||
If you encounter any issues or have questions, please reach out to our support team or consult the Langflow community forums.
|
||||
Loading…
Add table
Add a link
Reference in a new issue