Create Item with Zoho Books API on Link Clicked from Mailchimp API

Pipedream makes it easy to connect APIs for Zoho Books, Mailchimp and 2,500+ other apps remarkably fast.

Trigger workflow on

Link Clicked from the Mailchimp API

Next, do this

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

Select this integration
Configure the Link Clicked trigger
1. Connect your Mailchimp account
2. Configure timer
3. Select a Campaign ID
4. Select a Campaign Link
5. Configure Unique Clicks Only?
Configure the Create Item action
1. Connect your Zoho Books account
2. Configure Name
3. Configure Rate
4. Optional- Configure Description
5. Optional- Select a Tax Id
6. Optional- Configure Tax Percentage
7. Optional- Configure SKU
8. Optional- Select a Product Type
9. Optional- Configure HSN Or SAC
10. Optional- Configure Is Taxable
11. Optional- Configure Tax Exemption Id
12. Optional- Select a Account Id
13. Optional- Select a Item Type
14. Optional- Configure Purchase Description
15. Optional- Configure Purchase Rate
16. Optional- Configure Purchase Account Id
17. Optional- Configure Inventory Account Id
18. Optional- Configure Vendor Id
19. Optional- Configure Reorder Level
20. Optional- Configure Initial Stock
21. Optional- Configure Initial Stock Rate
22. Optional- Configure Item Tax Preferences
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#

Link Clicked on Mailchimp

Description:Emit new event when a recipient clicks a pre-specified link in an specific campaign.

Version:0.0.2

Key:mailchimp-link-clicked

View on GitHub

Mailchimp Overview#

The Mailchimp API taps into the heart of your email marketing efforts, allowing you to manage subscribers, campaigns, and reports. With the API, you can automate tasks like syncing subscriber lists, segmenting contacts based on behavior, and personalizing email content to match user profiles. It's a powerful tool for marketers looking to fine-tune their email strategy and maximize engagement.

Trigger Code#

import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "mailchimp-link-clicked",
  name: "Link Clicked",
  description: "Emit new event when a recipient clicks a pre-specified link in an specific campaign.",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    campaignId: {
      propDefinition: [
        common.props.mailchimp,
        "campaignId",
      ],
      description: "The unique ID of the campaign you'd like to watch for new clicks on links",
    },
    linkId: {
      propDefinition: [
        common.props.mailchimp,
        "linkId",
        (c) => ({
          campaignId: c.campaignId,
        }),
      ],
    },
    uniqueClicksOnly: {
      type: "boolean",
      label: "Unique Clicks Only?",
      description: "Whether to count every link click or only count clicks coming from each user only once",
      default: false,
    },
  },
  hooks: {
    async deploy() {
      // Emits sample events on the first run during deploy.
      return this.emitReportSampleEvents(this.campaignId, this.linkId, (Date.now()));
    },
  },
  methods: {
    ...common.methods,
    getEventTypes() {
      return [
        "clicks",
      ];
    },
    generateMeta({
      eventPayload,
      diff: clickDiff,
      timestamp: ts,
    }) {
      const { id: linkId } = eventPayload;
      return {
        id: `${linkId}-${ts}`,
        summary: `${clickDiff} new clicks`,
        ts,
      };
    },
    getCachedCampaignDetails() {
      return this.getDbServiceVariable("recipientClicks");
    },
    async getCampaignDetails() {
      return this.mailchimp.getCampaignClickDetailsForLink(
        this.campaignId,
        this.linkId,
      );
    },
    getNodataErrorMessage() {
      return "No data found for specified campaign and link.";
    },
    getCurrentCampaignDetails(report) {
      return this.uniqueClicksOnly
        ? report.unique_clicks
        : report.total_clicks;
    },
    getDetailsDiff(currentRecipientClicks, recipientClicks) {
      return currentRecipientClicks - recipientClicks;
    },
    cacheCampaignDetails(currentRecipientClicks) {
      if (isNaN(currentRecipientClicks)) {
        if (this.uniqueClicksOnly) {
          this.setDbServiceVariable("recipientClicks", currentRecipientClicks.unique_clicks);
        } else {
          this.setDbServiceVariable("recipientClicks", currentRecipientClicks.total_clicks);
        }
      } else {
        this.setDbServiceVariable("recipientClicks", currentRecipientClicks);
      }
    },
    clearCampaignDetailsCache() {
      this.setDbServiceVariable("recipientClicks", 0);
    },
  },
  async run() {
    return this.emitReportEvents();
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Mailchimp	`mailchimp`	`app`	This component uses the Mailchimp app.
	`timer`	`$.interface.timer`
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
Campaign Link	`linkId`	`string`	Select a value from the drop down menu.
Unique Clicks Only?	`uniqueClicksOnly`	`boolean`	Whether to count every link click or only count clicks coming from each user only once

Trigger Authentication#

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

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

About Mailchimp#

Mailchimp is a marketing automation and email marketing platform.

Action#

Create Item on Zoho Books

Description:Creates a new item. [See the documentation](https://www.zoho.com/books/api/v3/items/#create-an-item)

Version:0.3.0

Key:zoho_books-create-item

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.

Action Code#

// legacy_hash_id: a_Xzi1qo
import {
  ITEM_TYPE_OPTIONS, PRODUCT_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import zohoBooks from "../../zoho_books.app.mjs";

export default {
  key: "zoho_books-create-item",
  name: "Create Item",
  description: "Creates a new item. [See the documentation](https://www.zoho.com/books/api/v3/items/#create-an-item)",
  version: "0.3.0",
  type: "action",
  props: {
    zohoBooks,
    name: {
      type: "string",
      label: "Name",
      description: "Name of the item. Max-length [100]",
    },
    rate: {
      type: "string",
      label: "Rate",
      description: "Price of the item.",
    },
    description: {
      type: "string",
      label: "Description",
      description: "Description for the item. Max-length [2000]",
      optional: true,
    },
    taxId: {
      propDefinition: [
        zohoBooks,
        "taxId",
      ],
      description: "ID of the tax to be associated to the item.",
      optional: true,
    },
    taxPercentage: {
      type: "string",
      label: "Tax Percentage",
      description: "Percent of the tax.",
      optional: true,
    },
    sku: {
      type: "string",
      label: "SKU",
      description: "SKU value of item,should be unique throughout the product",
      optional: true,
    },
    productType: {
      type: "string",
      label: "Product Type",
      description: "Specify the type of an item.",
      optional: true,
      options: PRODUCT_TYPE_OPTIONS,
    },
    hsnOrSac: {
      type: "string",
      label: "HSN Or SAC",
      description: "HSN Code.",
      optional: true,
    },
    isTaxable: {
      type: "boolean",
      label: "Is Taxable",
      description: "Boolean to track the taxability of the item.",
      optional: true,
    },
    taxExemptionId: {
      type: "string",
      label: "Tax Exemption Id",
      description: "ID of the tax exemption. Mandatory, if is_taxable is false.",
      optional: true,
    },
    accountId: {
      propDefinition: [
        zohoBooks,
        "accountId",
      ],
      description: "ID of the account to which the item has to be associated with.",
      optional: true,
    },
    itemType: {
      type: "string",
      label: "Item Type",
      description: "Type of the item. Default value will be sales.",
      optional: true,
      options: ITEM_TYPE_OPTIONS,
    },
    purchaseDescription: {
      type: "string",
      label: "Purchase Description",
      description: "Purchase description for the item.",
      optional: true,
    },
    purchaseRate: {
      type: "string",
      label: "Purchase Rate",
      description: "Purchase price of the item.",
      optional: true,
    },
    purchaseAccountId: {
      type: "string",
      label: "Purchase Account Id",
      description: "ID of the COGS account to which the item has to be associated with. Mandatory, if item_type is purchase / sales and purchase / inventory.",
      optional: true,
    },
    inventoryAccountId: {
      type: "string",
      label: "Inventory Account Id",
      description: "ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.",
      optional: true,
    },
    vendorId: {
      type: "string",
      label: "Vendor Id",
      description: "Preferred vendor ID.",
      optional: true,
    },
    reorderLevel: {
      type: "string",
      label: "Reorder Level",
      description: "Reorder level of the item.",
      optional: true,
    },
    initialStock: {
      type: "string",
      label: "Initial Stock",
      description: "Opening stock of the item.",
      optional: true,
    },
    initialStockRate: {
      type: "string",
      label: "Initial Stock Rate",
      description: "Unit price of the opening stock.",
      optional: true,
    },
    itemTaxPreferences: {
      type: "string[]",
      label: "Item Tax Preferences",
      description: "A list of item tax objects. **Format: {\"tax_id\":\"12312312031200\",\"tax_specification\":\"intra\"}**",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.zohoBooks.createItem({
      $,
      data: {
        name: this.name,
        rate: this.rate && parseFloat(this.rate),
        description: this.description,
        tax_id: this.taxId,
        tax_percentage: this.taxPercentage,
        sku: this.sku,
        product_type: this.productType,
        hsn_or_sac: this.hsnOrSac,
        is_taxable: this.isTaxable,
        tax_exemption_id: this.taxExemptionId,
        account_id: this.accountId,
        item_type: this.itemType,
        purchase_description: this.purchaseDescription,
        purchase_rate: this.purchaseRate,
        purchase_account_id: this.purchaseAccountId,
        inventory_account_id: this.inventoryAccountId,
        vendor_id: this.vendorId,
        reorder_level: this.reorderLevel,
        initial_stock: this.initialStock,
        initial_stock_rate: this.initialStockRate,
        item_tax_preferences: parseObject(this.itemTaxPreferences),
      },
    });

    $.export("$summary", `Item successfully created with Id: ${response.item.item_id}`);
    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 Books	`zohoBooks`	`app`	This component uses the Zoho Books app.
Name	`name`	`string`	Name of the item. Max-length [100]
Rate	`rate`	`string`	Price of the item.
Description	`description`	`string`	Description for the item. Max-length [2000]
Tax Id	`taxId`	`string`	Select a value from the drop down menu.
Tax Percentage	`taxPercentage`	`string`	Percent of the tax.
SKU	`sku`	`string`	SKU value of item,should be unique throughout the product
Product Type	`productType`	`string`	Select a value from the drop down menu:`goodsservicedigital_service`
HSN Or SAC	`hsnOrSac`	`string`	HSN Code.
Is Taxable	`isTaxable`	`boolean`	Boolean to track the taxability of the item.
Tax Exemption Id	`taxExemptionId`	`string`	ID of the tax exemption. Mandatory, if is_taxable is false.
Account Id	`accountId`	`string`	Select a value from the drop down menu.
Item Type	`itemType`	`string`	Select a value from the drop down menu:`salespurchasessales_and_purchasesinventory`
Purchase Description	`purchaseDescription`	`string`	Purchase description for the item.
Purchase Rate	`purchaseRate`	`string`	Purchase price of the item.
Purchase Account Id	`purchaseAccountId`	`string`	ID of the COGS account to which the item has to be associated with. Mandatory, if item_type is purchase / sales and purchase / inventory.
Inventory Account Id	`inventoryAccountId`	`string`	ID of the stock account to which the item has to be associated with. Mandatory, if item_type is inventory.
Vendor Id	`vendorId`	`string`	Preferred vendor ID.
Reorder Level	`reorderLevel`	`string`	Reorder level of the item.
Initial Stock	`initialStock`	`string`	Opening stock of the item.
Initial Stock Rate	`initialStockRate`	`string`	Unit price of the opening stock.
Item Tax Preferences	`itemTaxPreferences`	`string[]`	A list of item tax objects. Format: {"tax_id":"12312312031200","tax_specification":"intra"}

Action 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

Create Item with Zoho Books API on Link Clicked from Mailchimp API

Pipedream makes it easy to connect APIs for Zoho Books, Mailchimp and 2,500+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

1
-
24
of
2,500+
apps by most popular