Notion
ToolJet can connect to a Notion workspace to do operations on notion pages, databases and blocks.
Connection
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.
Querying Notion
Notion API provides support for:
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.
Database
On database resource you can perform the following operations:
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=ZZZthenXXXis the database ID,YYYis the view ID andZZZis the page ID.
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=ZZZthenXXXis the database ID,YYYis the view ID andZZZis 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=ZZZthenXXXis the database ID,YYYis the view ID andZZZis 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:
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
5. Archive (delete) a page
Required parameters:
- Page ID
- Archive: Dropdown for archive and un archive the page
Blocks
The following operations can be performed on the block resource:
To get the id for blocks, simply click on the menu icon for the block and click "Copy link". Afterwards, paste the link in the browser and it should look like this: https://www.notion.so/Creating-Page-Sample-ee18b8779ae54f358b09221d6665ee15#7fcb3940a1264aadb2ad4ee9ffe11b0e the string after # is the block id i.e. 7fcb3940a1264aadb2ad4ee9ffe11b0e.
1. Retrieve a block
This operation retrieves a Block object using the ID specified.
Required parameters:
- Block ID
2. Append new block children
This operation creates and appends new children blocks to the parent block_id specified.
Required parameters:
- Block ID
- Children: Array of block objects
3. Retrieve block children
This operation retrieves a paginated array of child block objects contained in the block using the ID specified.
Required parameters:
- Block ID
- Limit
- Start cursor
4. Update a block
This operation updates the content for the specified block_id based on the block type.
Required parameters:
- Block ID
- Properties: The block object type value with the properties to be updated
- Archive
5. Delete a block
Required parameters:
- Block ID
User
The following operations can be performed on the user notion resource:
1. Retrieve a user from current workspace
This operation retrieves a User using the ID specified.
Required parameters:
- User ID
2. Retrieve list of users of a workspace
This operation returns a paginated list of Users for the workspace.
Required parameters:
- Limit
- Start cursor