New or Updated Record from Zoho Creator API

Pipedream makes it easy to connect APIs for Zoho Creator and 1,600+ other apps remarkably fast.

Trigger workflow on

New or Updated Record from the Zoho Creator API

Next, do this

Connect to 1,600+ APIs using code and no-code building blocks

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

Trigger a workflow on New or Updated Record with Zoho Creator API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Add steps to connect to 1,600+ APIs using code and no-code building blocks
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Send Message with Discord Webhook API on New or Updated Record from Zoho Creator API

Zoho Creator + Discord Webhook

Try it

Add Multiple Rows with Google Sheets API on New or Updated Record from Zoho Creator API

Zoho Creator + Google Sheets

Try it

Get Film with SWAPI - Star Wars API on New or Updated Record from Zoho Creator API

Zoho Creator + SWAPI - Star Wars

Try it

Create Multiple Records with Airtable API on New or Updated Record from Zoho Creator API

Zoho Creator + Airtable (API Key)

Try it

Custom Request with HTTP / Webhook API on New or Updated Record from Zoho Creator API

Zoho Creator + HTTP / Webhook

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.

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

Key:zoho_creator-new-or-updated-record

View on GitHub

Code#

import common from "../common.mjs";
import utils from "../../common/utils.mjs";
import constants from "../../constants.mjs";

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.2",
  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 id = JSON.stringify(record);
      return {
        id,
        summary: id,
        ts: Date.parse(record[constants.MODIFIED_TIME_FIELD]),
      };
    },
    validateRecord(record) {
      if (!record[constants.MODIFIED_TIME_FIELD]) {
        throw new Error("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);
    }
  },
};

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.

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