Find Records with Grist API on New Document Created (Instant) from Google Docs API

Pipedream makes it easy to connect APIs for Grist, Google Docs and 2,800+ other apps remarkably fast.

Trigger workflow on

New Document Created (Instant) from the Google Docs API

Next, do this

Find 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 Google Docs 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 New Document Created (Instant) trigger
1. Connect your Google Docs account
2. Configure Push notification renewal schedule
3. Optional- Select one or more Folder
Configure the Find Records action
1. Connect your Grist account
2. Configure Document ID
3. Select a Table ID
4. Optional- Configure Filter
5. Optional- Configure Limit
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 Document Created (Instant) on Google Docs

Description:Emit new event when a new document is created in Google Docs. [See the documentation](https://developers.google.com/drive/api/reference/rest/v3/changes/watch)

Version:0.0.5

Key:google_docs-new-document-created

View on GitHub

Google Docs Overview#

The Google Docs API allows you to create, read, and update Google Docs programmatically, enabling a wide range of automations and integrations with other apps and services. With Pipedream, you can harness this API to craft custom serverless workflows that trigger on various events, like form submissions, emails, or scheduled times, and perform actions like updating a document, extracting content, or even generating templated reports.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "google_docs-new-document-created",
  name: "New Document Created (Instant)",
  description: "Emit new event when a new document is created in Google Docs. [See the documentation](https://developers.google.com/drive/api/reference/rest/v3/changes/watch)",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    generateMeta(doc) {
      return {
        id: doc.documentId,
        summary: `New Document: ${doc.documentId}`,
        ts: Date.now(),
      };
    },
    async processChanges() {
      const lastFileCreatedTime = this._getLastFileCreatedTime();
      const timeString = new Date(lastFileCreatedTime).toISOString();

      const args = this.getListFilesOpts({
        q: `mimeType != "application/vnd.google-apps.folder" and createdTime > "${timeString}" and trashed = false`,
        orderBy: "createdTime desc",
        fields: "*",
      });

      const { files } = await this.googleDrive.listFilesInPage(null, args);
      if (!files?.length) {
        return;
      }
      await this.emitFiles(files);
      this._setLastFileCreatedTime(Date.parse(files[0].createdTime));
    },
  },
};

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 Docs	`googleDrive`	`app`	This component uses the Google Docs 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.
Folder	`folders`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

Google Docs uses OAuth authentication. When you connect your Google Docs account, Pipedream will open a popup window where you can sign into Google Docs 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 Docs API.

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

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

About Google Docs#

Use Google Docs to create, edit and collaborate on online documents.

Action#

Find Records on Grist

Description:Searches for records in a specified table. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/listRecords)

Version:0.0.3

Key:grist-find-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 utils from "../../common/utils.mjs";
import app from "../../grist.app.mjs";

export default {
  key: "grist-find-records",
  name: "Find Records",
  description: "Searches for records in a specified table. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/listRecords)",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    app,
    docId: {
      propDefinition: [
        app,
        "docId",
      ],
    },
    tableId: {
      propDefinition: [
        app,
        "tableId",
        ({ docId }) => ({
          docId,
        }),
      ],
    },
    filter: {
      type: "string",
      label: "Filter",
      description: "This is a JSON object mapping column names to arrays of allowed values. For example, to filter column pet for values cat and dog, the filter would be `{\"pet\": [\"cat\", \"dog\"]}`. Multiple columns can be filtered. For example the filter for pet being either `cat` or `dog`, AND `size` being either `tiny` or `outrageously small`, would be `{\"pet\": [\"cat\", \"dog\"], \"size\": [\"tiny\", \"outrageously small\"]}`",
      optional: true,
    },
    limit: {
      type: "integer",
      label: "Limit",
      description: "Return at most this number of rows. A value of 0 is equivalent to having no limit.",
      optional: true,
    },
  },
  methods: {
    findRecords({
      docId, tableId, ...args
    } = {}) {
      return this.app._makeRequest({
        path: `/docs/${docId}/tables/${tableId}/records`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      findRecords,
      docId,
      tableId,
      filter,
      limit,
    } = this;

    filter && utils.valueToObject(filter);

    const response = await findRecords({
      $,
      docId,
      tableId,
      params: {
        filter,
        limit,
      },
    });

    $.export("$summary", `Successfully found \`${response.records.length}\` record(s) in the table.`);

    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
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.
Filter	`filter`	`string`	This is a JSON object mapping column names to arrays of allowed values. For example, to filter column pet for values cat and dog, the filter would be `{"pet": ["cat", "dog"]}`. Multiple columns can be filtered. For example the filter for pet being either `cat` or `dog`, AND `size` being either `tiny` or `outrageously small`, would be `{"pet": ["cat", "dog"], "size": ["tiny", "outrageously small"]}`
Limit	`limit`	`integer`	Return at most this number of rows. A value of 0 is equivalent to having no limit.

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”

Try it

Add Or Update Records with Grist API on New Document Created (Instant) from Google Docs API

Google Docs + Grist

Try it

Add Records with Grist API on New or Updated Document (Instant) from Google Docs API

Google Docs + Grist

Try it

Add Or Update Records with Grist API on New or Updated Document (Instant) from Google Docs API

Google Docs + Grist

Try it

Find Records with Grist API on New or Updated Document (Instant) from Google Docs API

Google Docs + Grist

Try it

Popular Triggers#

New Document Created (Instant) from the Google Docs API

Emit new event when a new document is created in Google Docs. See the documentation

Try it

New or Updated Document (Instant) from the Google Docs API

Emit new event when a document is created or updated in Google Docs. See the documentation

Try it

New or Updated Record (Instant) from the Grist API

Emit new event once a record is updated or newly created in Grist. See the documentation

Try it

New Record (Instant) from the Grist API

Emit new event when a record is just created. See the documentation

Try it

Popular Actions#

Append Text with the Google Docs API

Append text to an existing document. See the documentation

Try it

Create a New Document with the Google Docs API

Create a new document. See the documentation

Try it

Append Image to Document with the Google Docs API

Appends an image to the end of a document. See the documentation

Try it

Create New Document From Template with the Google Docs API

Create a new Google Docs file from a template. Optionally include placeholders in the template document that will get replaced from this action. See documentation

Try it

Find Document with the Google Docs API

Search for a specific file by name. See the documentation for more information

Try it