Notion
ToolJet can connect to a Notion workspace to do operations on notion pages, databases and blocks.
Connection
To establish a connection with the Notion data source, click on the +Add new data source
button located on the query panel or navigate to the Data Sources page from the ToolJet dashboard.
For integrating Notion with ToolJet we will need the API token. The API token can be generated from your Notion workspace settings. Read the official Notion docs for Creating an internal integration with notion API.
![notion api](/img/datasource-reference/notion/api.png)
Querying Notion
Notion API provides support for:
![notion querying](/img/datasource-reference/notion/querying.png)
Before querying Notion, you must share the database with your integration. Click the share button in your database view, find your integration name select it.
![notion share](/img/datasource-reference/notion/share.png)
Database
On database resource you can perform the following operations:
![notion db](/img/datasource-reference/notion/db_q.png)
1. Retrieve a database
This operations retrieves a Database object using the ID specified.
Required parameters:
- Database ID: You'll find the Database ID in the url. Suppose this is the example url:
https://www.notion.so/workspace/XXX?v=YYY&p=ZZZ
thenXXX
is the database ID,YYY
is the view ID andZZZ
is the page ID.
![notion db retreieve](/img/datasource-reference/notion/db_retrieve.png)
2. Query a database
This operation gets a list of Pages contained in the database, filtered and ordered according to the filter conditions and sort criteria provided in the query.
Required parameters:
- Database ID : You'll find the Database ID in the url. Suppose this is the example url:
https://www.notion.so/workspace/XXX?v=YYY&p=ZZZ
thenXXX
is the database ID,YYY
is the view ID andZZZ
is the page ID.
Optional parameters:
- Filter : This must be an object of filters
- Sort : Array of sort objects
- Limit : limit for pagination
- Start Cursor : Next object id to continue pagination
3. Create a database
This operation creates a database as a subpage in the specified parent page, with the specified properties.
Required parameters:
- Database ID : You'll find the Database ID in the url. Suppose this is the example url:
https://www.notion.so/workspace/XXX?v=YYY&p=ZZZ
thenXXX
is the database ID,YYY
is the view ID andZZZ
is the page ID. - Page ID : Page ID of the parent
- Properties : Properties defines the columns in a database
Optional parameters:
- Title : Title should be an array of rich_text properties
- Icon type : Currently notion api accepts two icon options, emoji, external URL
- Icon value : Value of selected icon type
- Icon type : Currently notion api accepts only external URL
- Cover value : Value of selected cover type
4. Update a database
This operation updates an existing database as specified by the parameters.
Required parameters:
- Database ID
Optional parameters:
- Title : Title should be an array of rich_text properties
- Properties : Properties defines the columns in a database
- Icon type : Currently notion api accepts two icon options, emoji, external URL
- Icon value : Value of selected icon type
- Icon type : Currently notion api accepts only external URL
- Cover value : Value of selected cover type
Page
On page resource you can perform the following operations:
![notion page](/img/datasource-reference/notion/page_q.png)
1. Retrieve a page
This operation retrieves a Page object using the ID specified.
Required parameters:
- Page ID
2. Create a page
This operation creates a new page in the specified database or as a child of an existing page. If the parent is a database, the property values of the new page in the properties parameter must conform to the parent database's property schema. If the parent is a page, the only valid property is title.
Parameters:
- Page ID
- Properties : Property values of this page
- Icon type : Currently notion api accepts two icon options, emoji, external URL
- Icon value: Value of selected icon type
- Icon type : Currently notion api accepts only external URL
- Cover value : Value of selected cover type
3. Update a page
This operation updates page property values for the specified page. Properties that are not set via the properties parameter will remain unchanged.
Parameters:
- Page ID
- Parent type: A database parent or page parent
- Properties : Property values of this page
- Children : Page content for the new page as an array of block objects
- Icon type : Currently notion api accepts two icon options, emoji, external URL
- Icon value: Value of selected icon type
- Icon type : Currently notion api accepts only external URL
- Cover value : Value of selected cover type
4. Retrieve a page property item
This operation retrieves a property_item object for a given page ID and property ID. Depending on the property type, the object returned will either be a value or a paginated list of property item values. See Property item objects for specifics.
Parameters:
- Page ID
- Property ID
- Limit
- Start cursor