Skip to main content

Notion Component

Manage Notion pages, databases, and users

Component key: notion

Description#

Notion is a productivity and note-taking web application developed by Notion Labs Inc. It offers organizational tools including task management, project tracking, to-do lists, bookmarking, and more.

Notion Connections#

Notion OAuth 2.0 Connection#

To create an OAuth 2.0 app in Notion, visit notion.so/my-integrations and create a new integration. Take note of your integration's OAuth client ID and OAuth client secret and enter those values in Prismatic when you add a Notion connection to your integration. Under the Distribution page, add Prismatic's callback URL, https://oauth2.prismatic.io/callback.

InputDefaultNotesExample
Input
Authorize URL
string
/ Required
Hidden Field
authorizeUrl
Default
https://api.notion.com/v1/oauth/authorize?owner=user
Notes
The OAuth 2.0 Authorization URL for Notion
Example
 
Input
Client ID
string
/ Required
clientId
Default
Notes
Client Identifier of your app for the API
Example
secret_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
Input
Client Secret
password
/ Required
clientSecret
Default
Notes
Client Secret of your app for the API
Example
00000000-0000-0000-0000-000000000000
Input
Scopes
string
Hidden Field
scopes
Default
Notes
Scopes are not used for Notion
Example
 
Input
Token URL
string
/ Required
Hidden Field
tokenUrl
Default
https://api.notion.com/v1/oauth/token
Notes
The OAuth 2.0 Token URL for Notion
Example
 

Actions#

Get Current User#

Get the currently logged in user | key: getCurrentUser

InputNotes
Input
Connection
connection
/ Required
connection
Notes
 

Get Database#

Retrieve a database by ID | key: getDatabase

InputNotesExample
Input
Connection
connection
/ Required
connection
Notes
 
Example
 
Input
Database ID
string
/ Required
databaseId
Notes
 
Example
00000000-0000-0000-0000-000000000000

Get Page#

Retrieve a page by ID | key: getPage

InputNotesExample
Input
Connection
connection
/ Required
connection
Notes
 
Example
 
Input
Page ID
string
/ Required
pageId
Notes
 
Example
00000000-0000-0000-0000-000000000000

Get User by ID#

Get a user by their ID | key: getUser

InputNotesExample
Input
Connection
connection
/ Required
connection
Notes
 
Example
 
Input
User ID
string
/ Required
userId
Notes
 
Example
00000000-0000-0000-0000-000000000000

List Databases#

List all databases | key: listDatabases

InputNotesExample
Input
Connection
connection
/ Required
connection
Notes
 
Example
 
Input
Start Cursor
string
startCursor
Notes
The start cursor is returned from a previous 'list' action when at least one more page of records is available.
Example
00000000-0000-0000-0000-000000000000

List Pages#

Retrieve a page by ID | key: listPages

InputNotesExample
Input
Connection
connection
/ Required
connection
Notes
 
Example
 
Input
Start Cursor
string
startCursor
Notes
The start cursor is returned from a previous 'list' action when at least one more page of records is available.
Example
00000000-0000-0000-0000-000000000000

List Users#

List all users in the workspace | key: listUsers

InputNotesExample
Input
Connection
connection
/ Required
connection
Notes
 
Example
 
Input
Start Cursor
string
startCursor
Notes
The start cursor is returned from a previous 'list' action when at least one more page of records is available.
Example
00000000-0000-0000-0000-000000000000

Raw Request#

Send Raw Request to Notion | key: rawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
connection
Default
 
Notes
 
Example
 
Input
Data
string
data
Default
Notes
The HTTP body payload to send to the URL.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
debugRequest
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
fileData
Default
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
formData
Default
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
headers
Default
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
maxRetries
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
/ Required
method
Default
Notes
The HTTP method to use.
Example
 
Input
Query Parameter
string
Key Value List
queryParams
Default
Notes
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Example
 
Input
Response Type
string
/ Required
responseType
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
 
Input
Retry On All Errors
boolean
retryAllErrors
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Retry Delay (ms)
string
retryDelayMS
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Timeout
string
timeout
Default
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
url
Default
Notes
This is the URL to call.
Example
/pages
Input
Use Exponential Backoff
boolean
useExponentialBackoff
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example