Execute Custom Query with PostgreSQL API on New or Updated Record from Zoho Creator API

Pipedream makes it easy to connect APIs for PostgreSQL, Zoho Creator and 2,000+ other apps remarkably fast.

Trigger workflow on

New or Updated Record from the Zoho Creator API

Next, do this

Execute Custom Query with the PostgreSQL API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New or Updated Record trigger
1. Connect your Zoho Creator account
2. Configure Polling interval
3. Select a Application
4. Select a Report
Configure the Execute Custom Query action
1. Connect your PostgreSQL account
2. Configure SQL Query
3. Optional- Configure Values
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 or Updated Record on Zoho Creator

Description:Emit new or updated records in a report. The `Modified Time` field must be added as **Grouping** field in the Zoho Creator *record properties* for the **Report** chosen in the dropdown below. See [the grouping help article](https://www.zoho.com/creator/newhelp/reports/display-records-as-groups-list-report.html) and [the docs](https://www.zoho.com/creator/help/api/v2/get-records.html) for more information.

Version:0.0.3

Key:zoho_creator-new-or-updated-record

View on GitHub

Zoho Creator Overview#

Zoho Creator is a low-code platform that enables the building of custom applications tailored to business needs without extensive coding knowledge. Via its API, you can automate processes, manage data, and integrate with other services. Pipedream amplifies this capability by offering a serverless platform where events from various apps trigger workflows. You can use Zoho Creator’s API on Pipedream to create, read, update, and delete records, automate data flows, and link your custom apps with a myriad of other services for efficient, automated workflows.

Trigger Code#

import common from "../common.mjs";
import utils from "../../common/utils.mjs";
import constants from "../../constants.mjs";
import { ConfigurationError } from "@pipedream/platform";

const { zohoCreator } = common.props;
const { toSingleLineString } = utils;

export default {
  ...common,
  key: "zoho_creator-new-or-updated-record",
  description: toSingleLineString(`
    Emit new or updated records in a report. The \`Modified Time\` field must be added as
    **Grouping** field in the Zoho Creator *record properties* for the **Report** chosen in
    the dropdown below. See [the grouping help
    article](https://www.zoho.com/creator/newhelp/reports/display-records-as-groups-list-report.html)
    and [the docs](https://www.zoho.com/creator/help/api/v2/get-records.html) for more
    information.
  `),
  type: "source",
  name: "New or Updated Record",
  version: "0.0.3",
  dedupe: "unique",
  props: {
    ...common.props,
    reportLinkName: {
      propDefinition: [
        zohoCreator,
        "reportLinkName",
        ({ appLinkName }) => ({
          appLinkName,
        }),
      ],
      description: toSingleLineString(`
        The link name of the target report. The \`Modified Time\` field must be added as a
        **Grouping** field in the Zoho Creator *record properties* for the chosen report. See [the
        grouping help
        article](https://www.zoho.com/creator/newhelp/reports/display-records-as-groups-list-report.html).
      `),
    },
  },
  methods: {
    ...common.methods,
    getMetadata(record) {
      const ts = Date.parse(record[constants.MODIFIED_TIME_FIELD]);
      return {
        id: `${record.ID}-${ts}`,
        summary: JSON.stringify(record),
        ts,
      };
    },
    validateRecord(record) {
      if (!record[constants.MODIFIED_TIME_FIELD]) {
        throw new ConfigurationError("Record is missing the \"Modified Time\" field. Add the \"Modified Time\" Grouping field in the Zoho Creator record properties for the Report.");
      }
    },
    processEvent(record) {
      this.validateRecord(record);
      this.$emit(record, this.getMetadata(record));
      this.setLastTimestamp(record[constants.MODIFIED_TIME_FIELD]);
    },
  },
  async run() {
    const {
      appLinkName,
      reportLinkName,
    } = this;

    // If last timestamp is not set, use timestamp of 1 day ago
    // to avoid fetching all records on first run of the source
    const lastModifiedTime =
      this.getLastTimestamp()
      ?? await this.zohoCreator.daysAgoString({
        appLinkName,
        days: 1,
      });

    const recordsStream =
      await this.zohoCreator.getRecordsStream({
        appLinkName,
        reportLinkName,
        modifiedTime: lastModifiedTime,
      });

    for await (const record of recordsStream) {
      this.processEvent(record);
    }
  },
};

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
Zoho Creator	`zohoCreator`	`app`	This component uses the Zoho Creator app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	How often to poll the Zoho Creator API for resources
Application	`appLinkName`	`string`	Select a value from the drop down menu.
Report	`reportLinkName`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

ZohoCreator.form.CREATEZohoCreator.report.CREATEZohoCreator.report.READZohoCreator.report.UPDATEZohoCreator.report.DELETEZohoCreator.meta.form.READZohoCreator.meta.application.READZohoCreator.dashboard.READZohoCreator.bulk.CREATEZohoCreator.bulk.READ

About Zoho Creator#

Low-code platform

Action#

Execute Custom Query on PostgreSQL

Description:Executes a custom query you provide. [See the documentation](https://node-postgres.com/features/queries)

Version:2.0.5

Key:postgresql-execute-custom-query

View on GitHub

PostgreSQL Overview#

On Pipedream, you can leverage the PostgreSQL app to create workflows that automate database operations, synchronize data across platforms, and react to database events in real-time. Think handling new row entries, updating records from webhooks, or even compiling reports on a set schedule. Pipedream's serverless platform provides a powerful way to connect PostgreSQL with a variety of apps, enabling you to create tailored automation that fits your specific needs.

Action Code#

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

export default {
  name: "Execute Custom Query",
  key: "postgresql-execute-custom-query",
  description: "Executes a custom query you provide. [See the documentation](https://node-postgres.com/features/queries)",
  version: "2.0.5",
  type: "action",
  props: {
    postgresql,
    query: {
      propDefinition: [
        postgresql,
        "query",
      ],
    },
    values: {
      propDefinition: [
        postgresql,
        "values",
      ],
    },
  },
  async run({ $ }) {
    const {
      query,
      values = [],
    } = this;

    if (!Array.isArray(values)) {
      throw new Error("No valid values provided. The values property must be an array.");
    }

    const numberOfValues = query?.match(/\$/g)?.length || 0;
    if (values.length !== numberOfValues) {
      throw new Error("The number of values provided does not match the number of values in the query.");
    }

    try {
      const res = await this.postgresql.executeQuery({
        text: query,
        values,
      });
      $.export("$summary", "Successfully executed query");
      return res;
    } catch (error) {
      let errorMsg = "Query not executed due to an error. ";
      errorMsg += `${error}`.includes("SSL verification failed")
        ? "This could be because SSL verification failed. To resolve this, reconnect your account and set SSL Verification Mode: Skip Verification, and try again."
        : `${error}`;
      throw new Error(errorMsg);
    }
  },
};

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
PostgreSQL	`postgresql`	`app`	This component uses the PostgreSQL app.
SQL Query	`query`	`string`	Your custom SQL Query using `$1`, `$2`... to represent values (eg. `INSERT INTO users(name, email) VALUES($1, $2)`
Values	`values`	`string[]`	List of values represented in your SQL Query above

Action Authentication#

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

Before you connect to your PostgreSQL database from Pipedream, please make sure your database is either:

Accessible from the public internet (You may need to add a firewall rule on 0.0.0.0/0 on port 5432), or
Accessible from a static IP that you've configured from a VPC in Pipedream, and enabled the workflow to connect through that VPC

SSL Setup

Configure SSL on your PostgreSQL database by providing the CA (Certificate Authority), and choosing between Full Verification (default), or Skip Verification. Skipping verification is not recommended as this has serious security implications.