Append Block to Parent with Notion API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Append Block to Parent with the Notion API

No credit card required

▶

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 Append Block to Parent with the Notion API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Append Block to Parent action
1. Connect your Notion account
2. Select a Parent Block ID
3. Optional- Configure Block Objects
4. Optional- Select one or more Block IDs
5. Optional- Configure Markup Contents
6. Optional- Configure Image URLs
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#

Append Block to Parent with Notion API on New Message Sent from WhatsApp Business API

WhatsApp Business + Notion

Try it

Append Block to Parent with Notion API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Notion

Try it

Append Block to Parent with Notion API on New Item in Feed from RSS API

RSS + Notion

Try it

Append Block to Parent with Notion API on New Message from Discord API

Discord + Notion

Try it

Append Block to Parent with Notion API on New Message In Channels from Slack API

Slack + Notion

Try it

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.

Append Block to Parent on Notion

Description:Creates and appends blocks to the specified parent. [See the documentation](https://developers.notion.com/reference/patch-block-children)

Version:0.2.16

Key:notion-append-block

View on GitHub

Code#

import notion from "../../notion.app.mjs";
import base from "../common/base-page-builder.mjs";

export default {
  ...base,
  key: "notion-append-block",
  name: "Append Block to Parent",
  description: "Creates and appends blocks to the specified parent. [See the documentation](https://developers.notion.com/reference/patch-block-children)",
  version: "0.2.16",
  type: "action",
  props: {
    notion,
    pageId: {
      propDefinition: [
        notion,
        "pageId",
      ],
      label: "Parent Block ID",
      description: "The identifier for the parent block",
    },
    blockObjects: {
      type: "string[]",
      label: "Block Objects",
      description: "This prop accepts an array of block objects to be appended. Using a custom expression in this prop is recommended.",
      optional: true,
    },
    blockIds: {
      propDefinition: [
        notion,
        "pageId",
      ],
      type: "string[]",
      label: "Block IDs",
      description: "Contents of selected blocks will be appended",
      optional: true,
    },
    markupContents: {
      type: "string[]",
      label: "Markup Contents",
      description: "Content of new blocks to append. You must use Markdown syntax [See docs](https://www.notion.so/help/writing-and-editing-basics#markdown-&-shortcuts)",
      optional: true,
    },
    imageUrls: {
      type: "string[]",
      label: "Image URLs",
      description: "List of URLs to append as image blocks",
      optional: true,
    },
  },
  methods: {
    ...base.methods,
    chunkArray(array, chunkSize = 100) {
      const chunks = [];
      for (let i = 0; i < array.length; i += chunkSize) {
        chunks.push(array.slice(i, i + chunkSize));
      }
      return chunks;
    },
  },
  async run({ $ }) {
    const children = [];
    // add blocks from blockObjects
    if (this.blockObjects?.length > 0) {
      for (const obj of this.blockObjects) {
        const child = (typeof obj === "string")
          ? JSON.parse(obj)
          : obj;
        children.push(child);
      }
    }

    // add blocks from blockIds
    if (this.blockIds?.length > 0) {
      for (const id of this.blockIds) {
        const block = await this.notion.retrieveBlock(id);
        block.children = await this.notion.retrieveBlockChildren(block);
        const formattedChildren = await this.formatChildBlocks(block);
        children.push(...formattedChildren);
      }
    }

    // add blocks from markup
    if (this.markupContents?.length > 0) {
      for (const content of this.markupContents) {
        const block = this.createBlocks(content);
        children.push(...block);
      }
    }

    // add image blocks
    if (this.imageUrls?.length) {
      for (const url of this.imageUrls) {
        children.push({
          type: "image",
          image: {
            type: "external",
            external: {
              url,
            },
          },
        });
      }
    }

    if (children.length === 0) {
      $.export("$summary", "Nothing to append");
      return;
    }

    const results = [];
    const chunks = this.chunkArray(children);

    for (const chunk of chunks) {
      const { results: payload } = await this.notion.appendBlock(this.pageId, chunk);
      results.push(payload);
    }

    const totalAppended = results.reduce((sum, res) => sum + res.length, 0);

    $.export("$summary", `Appended ${totalAppended} block(s) successfully`);
    return results.flat();
  },
};

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.
Parent Block ID	`pageId`	`string`	Select a value from the drop down menu.
Block Objects	`blockObjects`	`string[]`	This prop accepts an array of block objects to be appended. Using a custom expression in this prop is recommended.
Block IDs	`blockIds`	`string[]`	Select a value from the drop down menu.
Markup Contents	`markupContents`	`string[]`	Content of new blocks to append. You must use Markdown syntax See docs
Image URLs	`imageUrls`	`string[]`	List of URLs to append as image blocks

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: