Add Or Update Records with Grist API on Updated Page in Database from Notion API

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

Trigger workflow on

Updated Page in Database from the Notion API

Next, do this

Add Or Update Records with the Grist 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#

This integration creates a workflow with a Notion trigger and Grist action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Updated Page in Database trigger
1. Connect your Notion account
2. Configure timer
3. Select a Database ID
4. Configure Include New Pages
5. Optional- Select one or more Property Types
Configure the Add Or Update Records action
1. Connect your Grist account
2. Configure Document ID
3. Select a Table ID
4. Optional- Configure Do Not Parse
5. Optional- Select a On Many
6. Optional- Configure No Add
7. Optional- Configure No Update
8. Configure Data Records
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

Updated Page in Database on Notion

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

Version:0.1.3

Key:notion-updated-page

View on GitHub

Notion Overview#

Notion's API allows for the creation, reading, updating, and deleting of pages, databases, and their contents within Notion. Using Pipedream's platform, you can build workflows that connect Notion with various other services to automate tasks such as content management, task tracking, and data synchronization. With Pipedream's serverless execution, you can trigger these workflows on a schedule, or by external events from other services, without managing any infrastructure.

Trigger Code#

import notion from "../../notion.app.mjs";
import sampleEmit from "./test-event.mjs";
import base from "../common/base.mjs";
import constants from "../common/constants.mjs";
import zlib from "zlib";

export default {
  ...base,
  key: "notion-updated-page",
  name: "Updated Page in Database", /* eslint-disable-line pipedream/source-name */
  description: "Emit new event when a page in a database is updated. To select a specific page, use `Updated Page ID` instead",
  version: "0.1.3",
  type: "source",
  dedupe: "unique",
  props: {
    ...base.props,
    databaseId: {
      propDefinition: [
        notion,
        "databaseId",
      ],
    },
    includeNewPages: {
      type: "boolean",
      label: "Include New Pages",
      description: "Set to `true` to emit events when pages are created. Set to `false` to ignore new pages.",
      default: true,
    },
    properties: {
      propDefinition: [
        notion,
        "propertyTypes",
        (c) => ({
          parentId: c.databaseId,
          parentType: "database",
        }),
      ],
      description: "Only emit events when one or more of the selected properties have changed",
      optional: true,
    },
  },
  hooks: {
    async activate() {
      console.log("Activating: fetching pages and properties");
      this._setLastUpdatedTimestamp(Date.now());
      const propertyValues = {};
      const propertiesToCheck = await this._getPropertiesToCheck();
      const params = this.lastUpdatedSortParam();
      const pagesStream = this.notion.getPages(this.databaseId, params);
      for await (const page of pagesStream) {
        for (const propertyName of propertiesToCheck) {
          const currentValue = this._maybeRemoveFileSubItems(page.properties[propertyName]);
          propertyValues[page.id] = {
            ...propertyValues[page.id],
            [propertyName]: currentValue,
          };
        }
      }
      this._setPropertyValues(propertyValues);
    },
    async deactivate() {
      console.log("Deactivating: clearing states");
      this._setLastUpdatedTimestamp(null);
    },
  },
  methods: {
    ...base.methods,
    _getLastUpdatedTimestamp() {
      return this.db.get(constants.timestamps.LAST_EDITED_TIME);
    },
    _setLastUpdatedTimestamp(ts) {
      this.db.set(constants.timestamps.LAST_EDITED_TIME, ts);
    },
    _getPropertyValues() {
      const compressed = this.db.get("propertyValues");
      const buffer = Buffer.from(compressed, "base64");
      const decompressed = zlib.inflateSync(buffer).toString();
      return JSON.parse(decompressed);
    },
    _setPropertyValues(propertyValues) {
      const string = JSON.stringify(propertyValues);
      const compressed = zlib.deflateSync(string).toString("base64");
      this.db.set("propertyValues", compressed);
    },
    async _getPropertiesToCheck() {
      if (this.properties?.length) {
        return this.properties;
      }
      const { properties } = await this.notion.retrieveDatabase(this.databaseId);
      return Object.keys(properties);
    },
    _maybeRemoveFileSubItems(property) {
      // Files & Media type:
      // `url` and `expiry_time` are constantly updated by Notion, so ignore these fields
      if (property.type === "files") {
        const modified = structuredClone(property);
        for (const file of modified.files) {
          if (file.type === "file") {
            delete file.file;
          }
        }
        return modified;
      }
      return property;
    },
    _generateMeta(obj, summary) {
      const { id } = obj;
      const title = this.notion.extractPageTitle(obj);
      const ts = Date.now();
      return {
        id: `${id}-${ts}`,
        summary: `${summary}: ${title}`,
        ts,
      };
    },
    _emitEvent(page, changes = [], isNewPage = true) {
      const meta = isNewPage
        ? this._generateMeta(page, constants.summaries.PAGE_ADDED)
        : this._generateMeta(page, constants.summaries.PAGE_UPDATED);
      const event = {
        page,
        changes,
      };
      this.$emit(event, meta);
    },
  },
  async run() {
    const lastCheckedTimestamp = this._getLastUpdatedTimestamp();
    const propertyValues = this._getPropertyValues();

    if (!lastCheckedTimestamp) {
      // recently updated (deactivated / activated), skip execution
      console.log("Awaiting restart completion: skipping execution");
      return;
    }

    const params = {
      ...this.lastUpdatedSortParam(),
      filter: {
        timestamp: "last_edited_time",
        last_edited_time: {
          on_or_after: new Date(lastCheckedTimestamp).toISOString(),
        },
      },
    };
    let newLastUpdatedTimestamp = lastCheckedTimestamp;
    const propertiesToCheck = await this._getPropertiesToCheck();
    const pagesStream = this.notion.getPages(this.databaseId, params);

    for await (const page of pagesStream) {
      const changes = [];
      let isNewPage = false;
      let propertyHasChanged = false;

      newLastUpdatedTimestamp = Math.max(
        newLastUpdatedTimestamp,
        Date.parse(page.last_edited_time),
      );

      if (lastCheckedTimestamp > Date.parse(page.last_edited_time)) {
        break;
      }

      for (const propertyName of propertiesToCheck) {
        const previousValue = structuredClone(propertyValues[page.id]?.[propertyName]);
        // value used to compare and to save to this.db
        const currentValueToSave = this._maybeRemoveFileSubItems(page.properties[propertyName]);
        // (unmodified) value that should be emitted
        const currentValueToEmit = page.properties[propertyName];

        const pageExistsInDB = propertyValues[page.id] != null;
        const propertyChanged =
          JSON.stringify(previousValue) !== JSON.stringify(currentValueToSave);

        if (pageExistsInDB && propertyChanged) {
          propertyHasChanged = true;
          propertyValues[page.id] = {
            ...propertyValues[page.id],
            [propertyName]: currentValueToSave,
          };
          changes.push({
            property: propertyName,
            previousValue,
            currentValue: currentValueToEmit,
          });
        }

        if (!pageExistsInDB) {
          isNewPage = true;
          propertyHasChanged = true;
          propertyValues[page.id] = {
            [propertyName]: currentValueToSave,
          };
          changes.push({
            property: propertyName,
            previousValue,
            currentValue: currentValueToEmit,
          });
        }
      }

      if (isNewPage && !this.includeNewPages) {
        console.log(`Ignoring new page: ${page.id}`);
        continue;
      }

      if (propertyHasChanged) {
        this._emitEvent(page, changes, isNewPage);
      }
    }

    this._setLastUpdatedTimestamp(newLastUpdatedTimestamp);
    this._setPropertyValues(propertyValues);
  },
  sampleEmit,
};

Trigger 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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Database ID	`databaseId`	`string`	Select a value from the drop down menu.
Include New Pages	`includeNewPages`	`boolean`	Set to `true` to emit events when pages are created. Set to `false` to ignore new pages.
Property Types	`properties`	`string[]`	Select a value from the drop down menu.

Trigger 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.

Action#

Add Or Update Records on Grist

Description:Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)

Version:0.0.2

Key:grist-add-update-records

View on GitHub

Grist Overview#

Grist API on Pipedream enables you to automate data management tasks in your Grist documents. This might mean syncing data across different platforms, triggering notifications based on data changes, or processing data through custom logic. With Pipedream, you can use the Grist API to build workflows that react to events in real-time, connect to hundreds of other services, manipulate data in sophisticated ways, and create custom endpoints to integrate with your Grist data.

Action Code#

import app from "../../grist.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "grist-add-update-records",
  name: "Add Or Update Records",
  description: "Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    docId: {
      propDefinition: [
        app,
        "docId",
      ],
    },
    tableId: {
      propDefinition: [
        app,
        "tableId",
        ({ docId }) => ({
          docId,
        }),
      ],
    },
    noParse: {
      propDefinition: [
        app,
        "noParse",
      ],
    },
    onMany: {
      type: "string",
      label: "On Many",
      description: "Which records to update if multiple records are found to match.",
      optional: true,
      options: [
        {
          value: "first",
          label: "The first matching record (default)",
        },
        {
          value: "none",
          label: "Do not update anything",
        },
        {
          value: "all",
          label: "Update all matches",
        },
      ],
    },
    noAdd: {
      type: "boolean",
      label: "No Add",
      description: "Set to true to prohibit adding records.",
      optional: true,
    },
    noUpdate: {
      type: "boolean",
      label: "No Update",
      description: "Set to true to prohibit updating records.",
      optional: true,
    },
    records: {
      description: app.propDefinitions.records.description + " Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. `[ { \"require\": { \"pet\": \"cat\" }, \"fields\": { \"popularity\": 67 } } ]`",
      propDefinition: [
        app,
        "records",
      ],
    },
  },
  methods: {
    addUpdateRecords({
      docId, tableId, ...args
    } = {}) {
      return this.app.put({
        path: `/docs/${docId}/tables/${tableId}/records`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      addUpdateRecords,
      docId,
      tableId,
      noParse: noparse,
      onMany: onmany,
      noAdd: noadd,
      noUpdate: noupdate,
      records,
    } = this;

    await addUpdateRecords({
      $,
      docId,
      tableId,
      params: {
        noparse,
        onmany,
        noadd,
        noupdate,
      },
      data: {
        records: utils.parseArray(records),
      },
    });

    $.export("$summary", "Successfully ran this action");

    return {
      success: true,
    };
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Grist	`app`	`app`	This component uses the Grist app.
Document ID	`docId`	`string`	The ID of the Grist document to operate on. You can find this in the Settings menu of the document.
Table ID	`tableId`	`string`	Select a value from the drop down menu.
Do Not Parse	`noParse`	`boolean`	Set to `true` to prohibit parsing strings according to the column type.
On Many	`onMany`	`string`	Select a value from the drop down menu:`{ "value": "first", "label": "The first matching record (default)" }{ "value": "none", "label": "Do not update anything" }{ "value": "all", "label": "Update all matches" }`
No Add	`noAdd`	`boolean`	Set to true to prohibit adding records.
No Update	`noUpdate`	`boolean`	Set to true to prohibit updating records.
Data Records	`records`	`string[]`	The data for the records to append or update. Each record should be a JSON-formatted string, mapping column names to cell values. Eg. `[ { "fields": { "pet": "cat", "popularity": 67 } } ]`. Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. `[ { "require": { "pet": "cat" }, "fields": { "popularity": 67 } } ]`

Action Authentication#

Grist uses API keys for authentication. When you connect your Grist account, Pipedream securely stores the keys so you can easily authenticate to Grist APIs in both code and no-code steps.

To retrieve your API key,

Navigate to your Girst account and sign in
Go to “Profile Settings” > “API”

About Grist#

The evolution of spreadsheets.

More Ways to Connect Grist + Notion#

Other Popular Integrations#

Add Records with Grist API on New Database from Notion API

Notion + Grist

Add Or Update Records with Grist API on Updated Page in Database from Notion API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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