Update Row with Zoho Analytics API on New Customer from Zoho Books API

Pipedream makes it easy to connect APIs for Zoho Analytics, Zoho Books and 3,000+ other apps remarkably fast.

Trigger workflow on

New Customer from the Zoho Books API

Next, do this

Update Row with the Zoho Analytics 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 Zoho Books trigger and Zoho Analytics action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Customer trigger
1. Connect your Zoho Books account
2. Configure timer
Configure the Update Row action
1. Connect your Zoho Analytics account
2. Select a Workspace Id
3. Select a View Id
4. Configure Columns
5. Optional- Configure Update All Rows
6. Optional- Configure Date Format
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 Customer on Zoho Books

Description:Emit new event when a new customer is created.

Version:0.0.2

Key:zoho_books-new-customer

View on GitHub

Zoho Books Overview#

Zoho Books API unlocks the potential to automate and streamline accounting tasks by integrating with Pipedream's serverless platform. With this powerful combo, you can automate invoicing, manage your accounts, reconcile bank transactions, and handle contacts and items without manual input. By setting up event-driven workflows, you can ensure data consistency across platforms, trigger notifications, and generate reports, all while saving time and reducing human error.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "zoho_books-new-customer",
  name: "New Customer",
  description: "Emit new event when a new customer is created.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getFunction() {
      return this.zohoBooks.listContacts;
    },
    getFieldName() {
      return "contacts";
    },
    getFieldId() {
      return "contact_id";
    },
    getSummary(item) {
      return `New Customer: ${item.contact_name}`;
    },
  },
  sampleEmit,
};

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 Books	`zohoBooks`	`app`	This component uses the Zoho Books app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

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

ZohoBooks.fullaccess.all

About Zoho Books#

Online accounting software

Action#

Update Row on Zoho Analytics

Description:Update rows in the specified table. [See the documentation](https://www.zoho.com/analytics/api/v2/#update-row)

Version:0.0.2

Key:zoho_analytics-update-row

View on GitHub

Zoho Analytics Overview#

The Zoho Analytics API lets you harness the power of your data by automating complex analytics tasks. With this API, you can create, access, and manage reports, dashboards, and KPI widgets programmatically. Integrate with Pipedream's serverless platform to trigger actions based on events, sync data across apps, and automate workflows without managing servers. Whether it's updating datasets in real-time or sending reports to your team, the possibilities stretch as wide as your data does.

Action Code#

import { parseOne } from "../../common/utils.mjs";
import zohoAnalytics from "../../zoho_analytics.app.mjs";

export default {
  key: "zoho_analytics-update-row",
  name: "Update Row",
  version: "0.0.2",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  description: "Update rows in the specified table. [See the documentation](https://www.zoho.com/analytics/api/v2/#update-row)",
  type: "action",
  props: {
    zohoAnalytics,
    workspaceId: {
      propDefinition: [
        zohoAnalytics,
        "workspaceId",
      ],
    },
    viewId: {
      propDefinition: [
        zohoAnalytics,
        "viewId",
        ({ workspaceId }) => ({
          workspaceId,
        }),
      ],
      withLabel: true,
    },
    columns: {
      propDefinition: [
        zohoAnalytics,
        "columns",
      ],
    },
    updateAllRows: {
      type: "boolean",
      label: "Update All Rows",
      description: "To update all the rows in the table.",
      optional: true,
      reloadProps: true,
    },
    dateFormat: {
      propDefinition: [
        zohoAnalytics,
        "dateFormat",
      ],
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.updateAllRows) {
      props.criteria = {
        type: "object",
        label: "Criteria",
        description: "If criteria is sent, then the rows matching the criteria alone are updated. Refer this [link](https://www.zoho.com/analytics/api/v2/index.html#applying-filter-criteria) for more details about how to construct a criteria.",
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      zohoAnalytics,
      workspaceId,
      viewId,
      criteria,
      ...data
    } = this;

    if (criteria) {
      let query = "1=1";

      Object.entries(parseOne(criteria)).map(([
        key,
        value,
      ]) => (
        query += `and "${viewId.label}"."${key}"='${value}'`
      ));

      data.criteria = query;
    }

    const response = await zohoAnalytics.updateRow({
      $,
      workspaceId,
      viewId: viewId.value,
      params: {
        CONFIG: JSON.stringify(data),
      },
    });

    const length = response.data.updatedRows;

    $.export("$summary", `${length} row${length > 1
      ? "s where"
      : " was"} successfully updated!`);

    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 Analytics	`zohoAnalytics`	`app`	This component uses the Zoho Analytics app.
Workspace Id	`workspaceId`	`string`	Select a value from the drop down menu.
View Id	`viewId`	`string`	Select a value from the drop down menu.
Columns	`columns`	`object`	JSONObject with column name as key and data as value. `Sample:` {"columnName1":"value1","columnName2":"value2"}
Update All Rows	`updateAllRows`	`boolean`	To update all the rows in the table.
Date Format	`dateFormat`	`string`	Specify this in-case any date field is being added and its format cannot be auto recognized. `Sample: dd-MMM-YYYY`. Refer this link for more details about how to construct a custom date format.

Action Authentication#

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

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

ZohoAnalytics.data.createZohoAnalytics.data.deleteZohoAnalytics.data.readZohoAnalytics.data.updateZohoAnalytics.metadata.readZohoAnalytics.usermanagement.readZohoAnalytics.modeling.create