Get Page Or Block Data with Roam Research API on New Comment (Instant) from Google Sheets API

Pipedream makes it easy to connect APIs for Roam Research, Google Sheets and 2,400+ other apps remarkably fast.

Trigger workflow on

New Comment (Instant) from the Google Sheets API

Next, do this

Get Page Or Block Data with the Roam Research 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 Google Sheets trigger and Roam Research action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Comment (Instant) trigger
1. Connect your Google Sheets account
2. Configure Push notification renewal schedule
3. Select a Spreadsheet
Configure the Get Page Or Block Data action
1. Connect your Roam Research account
2. Select a Resource Type
3. Configure Page Title Or Block UID
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#

New Comment (Instant) on Google Sheets

Description:Emit new event each time a comment is added to a spreadsheet.

Version:0.0.3

Key:google_sheets-new-comment

View on GitHub

Google Sheets Overview#

The Google Sheets API allows for the creation, reading, updating, and deletion of data within Google Sheets, enabling a robust platform for spreadsheet management and data manipulation. Through Pipedream, you can craft serverless workflows that respond to various triggers, such as webhook events, emails, or scheduled times, to interact with Google Sheets. This synergy can automate reporting, synchronize data across applications, manage inventory, track leads in a CRM, or even conduct survey analysis by updating and retrieving sheet data on the fly.

Trigger Code#

import httpBase from "../common/http-based/sheet.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...httpBase,
  key: "google_sheets-new-comment",
  name: "New Comment (Instant)",
  description: "Emit new event each time a comment is added to a spreadsheet.",
  version: "0.0.3",
  dedupe: "unique",
  type: "source",
  methods: {
    ...httpBase.methods,
    _getLastTs() {
      return this.db.get("lastTs");
    },
    _setLastTs(lastTs) {
      this.db.set("lastTs", lastTs);
    },
    generateMeta(comment) {
      return {
        id: comment.id,
        summary: `New Comment: ${comment.content}`,
        ts: Date.parse(comment.createdTime),
      };
    },
    takeSheetSnapshot() {},
    getSheetId() {
      return this.sheetID.toString();
    },
    async processSpreadsheet() {
      const comments = [];
      const lastTs = this._getLastTs();
      const results = this.googleSheets.listComments(this.sheetID, lastTs);
      for await (const comment of results) {
        comments.push(comment);
      }
      if (!comments.length) {
        return;
      }
      this._setLastTs(comments[0].createdTime);
      comments.reverse().forEach((comment) => {
        const meta = this.generateMeta(comment);
        this.$emit(comment, meta);
      });
    },
  },
  async run(event) {
    if (event.timestamp) {
      // Component was invoked by timer
      return this.renewSubscription();
    }

    if (!this.isEventRelevant(event)) {
      console.log("Sync notification, exiting early");
      return;
    }

    await this.processSpreadsheet();
  },
  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
Google Sheets	`googleSheets`	`app`	This component uses the Google Sheets app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Push notification renewal schedule	`timer`	`$.interface.timer`	The Google Drive API requires occasionally renewal of push notification subscriptions. This runs in the background, so you should not need to modify this schedule.
Spreadsheet	`sheetID`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

emailprofilehttps://www.googleapis.com/auth/drive

About Google Sheets#

Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.

Action#

Get Page Or Block Data on Roam Research

Description:Get the data for a page or block in Roam Research (access only to non ecrypted graphs). [See the documentation](https://roamresearch.com/#/app/developer-documentation/page/eb8OVhaFC).

Version:0.0.2

Key:roamresearch-get-page-or-block-data

View on GitHub

Action Code#

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

export default {
  key: "roamresearch-get-page-or-block-data",
  name: "Get Page Or Block Data",
  description: "Get the data for a page or block in Roam Research (access only to non ecrypted graphs). [See the documentation](https://roamresearch.com/#/app/developer-documentation/page/eb8OVhaFC).",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    resourceType: {
      propDefinition: [
        app,
        "resourceType",
      ],
    },
    pageOrBlock: {
      propDefinition: [
        app,
        "pageOrBlock",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      resourceType,
      pageOrBlock,
    } = this;

    const attribute = resourceType === "page"
      ? ":node/title"
      : ":block/uid";

    const response = await app.pull({
      $,
      data: {
        selector: `[${attribute} :block/string :block/order {:block/children ...}]`,
        eid: `[${attribute} "${pageOrBlock}"]`,
      },
    });

    if (!response.result) {
      $.export("$summary", `Failed to get data for ${resourceType}: \`${pageOrBlock}\`.`);
      return response;
    }

    $.export("$summary", `Successfully got data for ${resourceType}: \`${pageOrBlock}\`.`);
    return response;
  },
};

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
Roam Research	`app`	`app`	This component uses the Roam Research app.
Resource Type	`resourceType`	`string`	Select a value from the drop down menu:`pageblock`
Page Title Or Block UID	`pageOrBlock`	`string`	The page title of the block uid to get data for. Page title example: `My Page` and Block UID example: `ideWWvTgI`.

Action Authentication#

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

About Roam Research#

A note-taking tool for networked thought.

More Ways to Connect Roam Research + Google Sheets#

Other Popular Integrations#

Get Page Or Block Data with Roam Research API on New Row Added (Instant) from Google Sheets API

Google Sheets + Roam Research

Get Page Or Block Data with Roam Research API on New Comment (Instant) from Google Sheets API

Pipedream makes it easy to connect APIs for Roam Research, Google Sheets 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