Explore Templates Docs Changelog Pricing Blog Community Partners

Retrieve Database Schema with Notion API

Pipedream makes it easy to connect APIs for Notion and 2,200+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Retrieve Database Schema with the Notion API

No credit card required

Intro to Pipedream

▶

Watch us build a workflow

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Retrieve Database Schema with the Notion API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Retrieve Database Schema action
1. Connect your Notion account
2. Select a Database ID
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Retrieve Database Schema with Notion API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Notion

Retrieve Database Schema with Notion API on New Submission from Typeform API

Typeform + Notion

Retrieve Database Schema with Notion API on Custom Events from Zoom API

Zoom + Notion

Retrieve Database Schema with Notion API on New Submission (Instant) from Jotform API

Jotform + Notion

Retrieve Database Schema with Notion API on New Custom Webhook Events from Stripe API

Stripe + Notion

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Retrieve Database Schema on Notion

Description:Retrieves a database object. Database objects describe the property schema of a database in Notion. [See the docs](https://developers.notion.com/reference/retrieve-a-database)

Version:0.0.5

Key:notion-retrieve-database-schema

Code#

import notion from "../../notion.app.mjs";

export default {
  key: "notion-retrieve-database-schema",
  name: "Retrieve Database Schema",
  description: "Retrieves a database object. Database objects describe the property schema of a database in Notion. [See the docs](https://developers.notion.com/reference/retrieve-a-database)",
  version: "0.0.5",
  type: "action",
  props: {
    notion,
    databaseId: {
      propDefinition: [
        notion,
        "databaseId",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.notion.retrieveDatabase(this.databaseId);
    $.export("$summary", "Retrieved database successfully");
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Notion	`notion`	`app`	This component uses the Notion app.
Database ID	`databaseId`	`string`	Select a value from the drop down menu.

Authentication#

Notion uses OAuth authentication. When you connect your Notion account, Pipedream will open a popup window where you can sign into Notion and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Notion API.

Pipedream requests the following authorization scopes when you connect your account:

About Notion#

Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.

More Ways to Use Notion#

Triggers#

New Database from the Notion API

Emit new event when a database is created. Note: Databases must be shared with your Pipedream Integtration to trigger event.

New Page in Database from the Notion API

Emit new event when a page in a database is created

Page or Subpage Updated from the Notion API

Emit new event when a page or one of its sub-pages is updated.

Updated Page ID from the Notion API

Emit new event when a selected page is updated

Updated Page in Database from the Notion API

Emit new event when a page in a database is updated. To select a specific page, use Updated Page ID instead

Actions#

Append Block to Parent with the Notion API

Creates and appends blocks to the specified parent. See the documentation

Create Page with the Notion API

Creates a page from a parent page. The only valid property is title. See the documentation

Create Page from Database with the Notion API

Creates a page from a database. See the docs

Duplicate Page with the Notion API

Creates a new page copied from an existing page block. See the docs

Find a Page with the Notion API

Searches for a page by its title. See the docs

Explore Other Apps#

1
-
24
of
2,200+
apps by most popular

HTTP / Webhook

Get a unique URL where you can send HTTP or webhook requests

Node

Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.

Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.

OpenAI (ChatGPT)

OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.

Web services API for interacting with Salesforce

HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.

Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.

Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

WooCommerce

WooCommerce is the open-source ecommerce platform for WordPress.

A data warehouse built for the cloud

MongoDB is an open source NoSQL database management program.

Supabase is an open source Firebase alternative.

MySQL is an open-source relational database management system.

PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.

AWS

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Twilio SendGrid

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation

Email Marketing and SMS Marketing Platform

Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.

Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

Microsoft Teams

Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.

Trigger workflows on an interval or cron schedule.

a b c d e f g h i j k l m n o p q r s t u v w x y z #