Elgato_dark/ToolJet
1
0
Fork 0
mirror of https://github.com/ToolJet/ToolJet synced 2026-05-21 07:59:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
ToolJet/docs/docs/data-sources/notion.md
Muhsin Shah C P 22991ae900
[Feature] Notion plugin 🚀 (#2853) 
* initialized the plugin

* Added token field and notion svg icon

* added notion js client

* Added token authentication

* Added database query and retrieve operations

* Working on other operations of database and page

* Added archive page & get single property operations

* Resolved an issue & changed placeholders

* Added operations of block

* Added start cursor to page & database

* Added operations of user endpoint

* changed icon & cover from object to fields

* Updated documentation
2022-04-26 14:58:48 +05:30

3.1 KiB
Raw Blame History

notion

ToolJet can connect to a Notion workspace to do operations on notion pages, databases and blocks.

Connection

We can easily integrate notion with tooljet using just an API token. Read Create internal integration with notion API

Querying Notion

Notion API provides api support for database, page, block, user

Database

  • Retrieve a database

    Properties

    • Database ID

  • Query a database

    Properties

    • Database ID
    • Filter : This must be an object of filters
    • Children : Array of sort objects
    • Limit : limit for pagination
    • Start Cursor : Next object id to continue pagination

  • Create a database

    Properties

    • Database ID
    • 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

  • Update a database

    Properties

    • Database ID
    • Title
    • Properties
    • Icon type
    • Icon value
    • Icon type
    • Cover value

Page

  • Retrieve a page

    Properties

    • Page ID

  • Retrieve a page property item

    Properties

    • Page ID
    • Property ID
    • Limit
    • Start cursor

  • Update a page

    Properties

    • 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

  • Create a page

    Properties

    • 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

  • Archive (delete) a page

    Properties

    • Page ID
    • Archive: Dropdown for archive and un archive the page

Blocks

  • Retrieve a block

    Properties

    • Block ID

  • Retrieve block children

    Properties

    • Block ID
    • Limit
    • Start cursor

  • Update a block

    Properties

    • Block ID
    • Properties: The block object type value with the properties to be updated
    • Archive

  • Append new block children

    Properties

    • Block ID
    • Children: Array of block objects

  • Delete a block

    Properties

    • Block ID

User

  • Retrieve a user from current workspace

    Properties

    • User ID

  • Retrieve list of users of a workspace

    Properties

    • Limit
    • Start cursor

Read more about notion API