Notion Integration with Orkes Conductor
Available since
- v5.3.0 and later
Connected Apps must be enabled on your cluster
Connected Apps are enabled per cluster. If Integrations > Connected Apps is not in the left navigation, contact Orkes support to enable it before following these steps.
Integrating Notion with Orkes Conductor lets you build workflows that interact with your Notion using the following operations:
- Create Page
- Retrieve Page
- Update Page
- Retrieve Page Property
- Create Database
- Retrieve Database
- Update Database
- List Databases
- Query Database
- Retrieve Block
- Update Block
- Delete Block
- Retrieve Block Children
- Append Block Children
- Create Comment
- List Comments
- List Users
- Retrieve User
- Get Current User
- Search
This guide explains how to set up and use the integration. Here’s an overview:
- Get the required credentials from Notion.
- Configure a new Notion integration in Orkes Conductor.
- Use Notion integration in workflows.
Step 1: Get the Notion credentials
To integrate Notion with Orkes Conductor, create a Notion integration and retrieve the API token.
Create a Notion integration
To create the integration:
- Go to Developers > Connections.
- Select + New connection.
- Enter a name for your integration.
- Select Authentication method as Access token.
- Select the workspace where you want to use the integration, and select Create connection.
Next, edit the integration to add capabilities.
- In Capabilities, enable the following:
- Content capabilities: Read content, Update content, and Insert content.
- Comment capabilities: Read comments and Insert comments.
- User capabilities: Read user information including email addresses.
- Save the integration.
- Copy and store the Access token.
Share pages or databases with your integration
After creating the integration, share the required pages or databases you want to access with it:
- Open the page or database you want to access via the integration.
- Select the ... menu in the top right.
- Scroll down and select Connections.
- Search for your integration name and select it.
The integration now has access to that page or database and its children.
Step 2: Add an integration for Notion
After obtaining the credentials, add a Notion integration to your Conductor cluster.
To create an integration:
- Go to Integrations > Connected Apps from the left navigation menu on your Conductor cluster.
- Select + New integration.
- In the Productivity section, choose Notion.
- Select + Add and enter the following parameters:
| Parameter | Description | Required/Optional |
|---|---|---|
| Integration name | A name for the integration. | Required. |
| Notion API Token | The internal integration secret generated in Step 1. | Required. |
| Description | A description of the integration. | Required. |
- (Optional) Toggle the Active button off if you don't want to activate the integration instantly.
- Select Save.
Step 3: Use Notion integration in workflows
Once the integration is ready, this can be used directly within the workflows.
To use Notion integration in a workflow:
- Go to Definitions > Workflow from the left navigation menu on your Conductor cluster.
- Select + Define workflow.
- In your workflow, select the (+) icon and select Connected Apps.
- In Add Task panel on the right, search for Notion, and select the integration created in Step 2.
The following operations are available for use with this integration.
| Operation | Description |
|---|---|
| Create Page | Create a new page with properties and content. |
| Retrieve Page | Get page details and properties by ID. |
| Update Page | Update page properties and archive status. |
| Retrieve Page Property | Get specific property values (with pagination support). |
| Create Database | Create a new database with schema definition. |
| Retrieve Database | Get database details and schema by ID. |
| Update Database | Update database properties and schema. |
| List Databases | List all databases accessible to the integration. |
| Query Database | Query database entries with filtering and sorting. |
| Retrieve Block | Get block details by ID. |
| Update Block | Update block content and properties. |
| Delete Block | Archive a block. |
| List Block Children | Get child blocks of a page or block (with pagination). |
| Append Block Children | Add new blocks to a parent block or page. |
| Create Comment | Add a comment to a page or discussion thread. |
| List Comments | Get comments for a specific block or page. |
| List Users | Get all users in the workspace (with pagination). |
| Retrieve User | Get user details by ID. |
| Get Current User | Get the bot user associated with the API token. |
| Search | Search for pages and databases by title (with filtering and sorting). |
- Select the required operation, configure the parameters, and select Save > Confirm.
- Select Execute to run the workflow.
For the complete operations parameters and output reference, see Notion Operations Reference.