← Zoho Creator

New Record from Zoho Creator API

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

Trigger workflow on
New Record from the Zoho Creator API
Next, do this
Connect to 700+ APIs using code and no-code building blocks
No credit card required
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

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

  1. Configure the New Record trigger
    1. Connect your Zoho Creator account
    2. Configure Polling interval
    3. Select a Application
    4. Select a Report
  2. Add steps to connect to 700+ APIs using code and no-code building blocks
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source 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 Record on Zoho Creator
Description:Emit new records in a report. The `Added Time` field must be added as a **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.1
Key:zoho_creator-new-record

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-record",
  description: toSingleLineString(`
    Emit new records in a report. The \`Added Time\` field must be added as a **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 Record",
  version: "0.0.1",
  dedupe: "unique",
  props: {
    ...common.props,
    reportLinkName: {
      propDefinition: [
        zohoCreator,
        "reportLinkName",
        ({ appLinkName }) => ({
          appLinkName,
        }),
      ],
      description: toSingleLineString(`
        The link name of the target report. The \`Added 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) {
      return {
        id: record.ID,
        summary: JSON.stringify(record),
        ts: Date.parse(record[constants.ADDED_TIME_FIELD]),
      };
    },
    validateRecord(record) {
      if (!record[constants.ADDED_TIME_FIELD]) {
        throw new Error("Record is missing the \"Added Time\" field. Add the \"Added 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.ADDED_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 lastAddedTime =
      this.getLastTimestamp()
      ?? await this.zohoCreator.daysAgoString({
        appLinkName,
        days: 1,
      });

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

    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.
LabelPropTypeDescription
Zoho CreatorzohoCreatorappThis component uses the Zoho Creator app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
Polling intervaltimer$.interface.timer

How often to poll the Zoho Creator API for resources

ApplicationappLinkNamestringSelect a value from the drop down menu.
ReportreportLinkNamestringSelect 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.meta.form.READZohoCreator.meta.application.READZohoCreator.dashboard.READ

About Zoho Creator

Low-code platform

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday