Notion Resource
The Notion Resource provides easy access to the Notion API (opens in a new tab), allowing you to quickly build apps on top of your existing Notion databases.
Configuration Steps
- The Dynaboard / Notion integration works using an Internal Integration which you can configure in Notion's integrations dashboard (opens in a new tab).
- Once open: click on "New Integration", enter a name, select a workspace, assign permissions, and click "Submit".
- If the workspace you want to integrate isn't listed, you'll need to be added as an administrator to it before continuing.
- At a minimum Dynaboard will need the Read content capability. If you'd also like to modify your Notion databases from Dynaboard, you'll need to add Update and Insert as well.
- Once you've created the integration, copy the Internal Integration Token and paste it into the API key field in Dynaboard. Click the ✓ to the right of the field to save the key.
- Important: To access each Notion database in your workspace you need to explicitly share it with your new integration.
- To do this: navigate to the main page of the desired database, click on "Share" in the top right corner, click the "Invite" field, and select the integration you just created.
- Test your new integration by creating / testing a list databases function to see if your recently shared database(s) is returned.
Common Configuration Errors
- The correct database may not have been shared with your integration in Notion.
- Your account is not an administrator on the Notion Workspace you'd like to connect to.
- A secret may be unsaved (e.g. passwords or certificates). Click the ✓ to the right of the field to save it. The text will disappear after a successful save.
Properties
Environment Profiles
| Prop | profiles |
|---|---|
| Type | array |
| Default | [ { 'environment': '' } ] |
The profiles configured for this resource in an environment
Environment Profile
| Prop | profiles[] |
|---|---|
| Type | object |
| Default | undefined |
A profile of this resource for an environment
Notion API Key
| Prop | profiles[].apiKey |
|---|---|
| Type | ({ ref: string } | undefined) |
| Default | undefined |
The internal integration token (API key) to use when connecting to the Notion API.
Environment
| Prop | profiles[].environment |
|---|---|
| Type | string |
| Default | undefined |
The name of the environment with which this profile is associated
Actions
List Databases
Lists all databases accessible via the provided Notion API key.
| Parameter | Type | Default |
|---|---|---|
startCursor | string | undefined |
pageSize | string | undefined |
Query Database
Performs a query on an existing Notion database.
| Parameter | Type | Default |
|---|---|---|
databaseId | string | undefined |
startCursor | string | undefined |
pageSize | string | undefined |
Update Database
Updates existing pages (rows) within a Notion database.
| Parameter | Type | Default |
|---|---|---|
databaseId | string | undefined |
properties | unknown | undefined |
Create Page in Database
Creates a new page (row) in an existing Notion database.
| Parameter | Type | Default |
|---|---|---|
databaseId | string | undefined |
properties | unknown | undefined |