Skip to content
Nappai Documentation

List Database Properties

This component helps you understand the structure of your Notion databases within Nappai. It retrieves information about the fields and properties of a chosen database, making it easier to work with your data.

Relationship with Notion API

This component connects directly to the Notion API to fetch the details of your database. You’ll need to provide your Notion database ID and a credential to allow Nappai to access your Notion account securely.

Inputs

  • Database ID: This is a unique identifier for your Notion database. You can find this ID in the Notion database URL. It looks something like abcdef1234567890.
  • Credential: This is your authentication information for accessing your Notion account. Nappai uses this to securely connect to your Notion data. You’ll need to configure this credential beforehand in Nappai’s settings.

Outputs

The component produces two types of output:

  • Database Properties (data): This output provides a detailed description of your database’s structure in an easy-to-understand format. You can use this information to understand what kind of data is stored in your database and how it’s organized.
  • Message (text): This output displays a message confirming the successful retrieval of the database properties or provides an error message if something goes wrong (e.g., incorrect Database ID or credential issues).

Usage Example

Let’s say you have a Notion database with the ID abcdef1234567890 and you’ve already set up your Notion credential in Nappai. You would provide these two inputs to the “List Database Properties” component. The component will then fetch the database properties and display them in the dashboard. You can then use this information to build other parts of your automation workflow.

Templates

[List of templates where the component can be seen and its configuration - This section needs information from the system to be populated.]

  • OpenAI Function Agent: This component can use the database properties retrieved by “List Database Properties” to generate text based on your Notion data.
  • ReAct Agent LLM: This component can use the database structure to build more intelligent interactions with your Notion data.
  • Other Components: Many other Nappai components can utilize the structured data output from this component to perform various actions, such as filtering, transforming, and exporting your data. [List other relevant components and their brief descriptions - This section needs information from the system to be populated.]

Tips and Best Practices

  • Double-check your Database ID: Ensure you’ve copied the correct Database ID from your Notion database URL. A small mistake can prevent the component from working.
  • Secure your Credentials: Protect your Notion credentials. Do not share them publicly.

Security Considerations

  • The component only accesses your Notion data with the explicitly provided credentials. Nappai does not store your Notion credentials permanently. Always ensure you are using a strong and unique credential for your Notion integration.