Upload File with Zoho WorkDrive API on New or Updated Record from Zoho Creator API

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

Trigger workflow on

New or Updated Record from the Zoho Creator API

Next, do this

Upload File with the Zoho WorkDrive 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 Zoho WorkDrive 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 Upload File action
1. Connect your Zoho WorkDrive account
2. Select a Team Id
3. Select a Parent Id
4. Optional- Configure Filename
5. Optional- Configure Override Name Exist
6. Configure File Path
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#

Upload File on Zoho WorkDrive

Description:Upload a new file to your WorkDrive account. [See the documentation](https://workdrive.zoho.com/apidocs/v1/chunkupload/chunkuploadcreatesession)

Version:0.0.2

Key:zoho_workdrive-upload-file

View on GitHub

Zoho WorkDrive Overview#

The Zoho WorkDrive API interacts with Zoho's cloud-based file management system, enabling automated file and folder operations, team management, and content collaboration. With Pipedream, you can harness this API to create workflows that trigger on specific events, manipulate files and folders, and integrate with other services for a seamless productivity boost.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import FormData from "form-data";
import fs from "fs";
import { getFilePath } from "../../common/utils.mjs";
import app from "../../zoho_workdrive.app.mjs";

export default {
  key: "zoho_workdrive-upload-file",
  name: "Upload File",
  version: "0.0.2",
  description: "Upload a new file to your WorkDrive account. [See the documentation](https://workdrive.zoho.com/apidocs/v1/chunkupload/chunkuploadcreatesession)",
  type: "action",
  props: {
    app,
    teamId: {
      propDefinition: [
        app,
        "teamId",
      ],
    },
    parentId: {
      propDefinition: [
        app,
        "parentId",
        ({ teamId }) => ({
          teamId,
        }),
      ],
    },
    filename: {
      label: "Filename",
      description: "The name of the file should be URL encoded with UTF-8 Charset.",
      type: "string",
      optional: true,
    },
    overrideNameExist: {
      type: "boolean",
      label: "Override Name Exist",
      description: "If set as **true**, a file with the matching name will be uploaded as a top version over the existing file. If set as **false**, a file with the matching name will have the timestamp added to it on upload.",
      optional: true,
    },
    content: {
      label: "File Path",
      description: "Full path to the file in `/tmp/` directory. E.g. `/tmp/file.jpg`",
      type: "string",
    },
  },
  async run({ $ }) {
    const path = getFilePath(this.content);
    if (!fs.existsSync(path)) {
      throw new ConfigurationError("File does not exist!");
    }
    const file = fs.createReadStream(path);
    const data = new FormData();
    const override = this.overrideNameExist?.toString();

    data.append("content", file);
    data.append("parent_id", this.parentId);
    if (this.filename)data.append("filename", this.filename);
    if (override)data.append("override-name-exist", override);

    const response = await this.app.uploadFile({
      $,
      data,
      headers: {
        "Content-Type": `multipart/form-data; boundary=${data._boundary}`,
      },
    });

    $.export("$summary", "The file was successfully uploaded!");
    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
Zoho WorkDrive	`app`	`app`	This component uses the Zoho WorkDrive app.
Team Id	`teamId`	`string`	Select a value from the drop down menu.
Parent Id	`parentId`	`string`	Select a value from the drop down menu.
Filename	`filename`	`string`	The name of the file should be URL encoded with UTF-8 Charset.
Override Name Exist	`overrideNameExist`	`boolean`	If set as true, a file with the matching name will be uploaded as a top version over the existing file. If set as false, a file with the matching name will have the timestamp added to it on upload.
File Path	`content`	`string`	Full path to the file in `/tmp/` directory. E.g. `/tmp/file.jpg`

Action Authentication#

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

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

WorkDrive.files.CREATEWorkDrive.files.READWorkDrive.files.UPDATEWorkDrive.files.DELETEWorkDrive.team.READWorkDrive.teamfolders.READWorkDrive.workspace.CREATEWorkDrive.workspace.UPDATEWorkDrive.workspace.DELETEZohoSearch.securesearch.READZohoFiles.files.READ

About Zoho WorkDrive#

Online file management for teams

More Ways to Connect Zoho WorkDrive + Zoho Creator#

Other Popular Integrations#

Upload File with Zoho WorkDrive API on New Record from Zoho Creator API

Zoho Creator + Zoho WorkDrive

Try it

Download File to Tmp Direcory with Zoho WorkDrive API on New or Updated Record from Zoho Creator API

Zoho Creator + Zoho WorkDrive

Try it

Download File to Tmp Direcory with Zoho WorkDrive API on New Record from Zoho Creator API

Zoho Creator + Zoho WorkDrive

Try it

Popular Triggers#

New or Updated Record from the Zoho Creator API

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 and the docs for more information.

Try it

New Record from the Zoho Creator API

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 and the docs for more information.

Try it

New File In Folder from the Zoho WorkDrive API

Emit new event when a new file is created in a specific folder.

Try it

New Folder from the Zoho WorkDrive API

Emit new event when a new folder is created in a specific folder.

Try it