Create Subscription with Chargebee API on New Email from Zoho Mail API

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

Trigger workflow on

New Email from the Zoho Mail API

Next, do this

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

Select this integration
Configure the New Email trigger
1. Connect your Zoho Mail account
2. Configure Polling Interval
3. Select a Account ID
4. Optional- Configure Max
Configure the Create Subscription action
1. Connect your Chargebee account
2. Select a Customer ID
3. Select a Plan Item Price ID
4. Configure Unit Price
5. Configure Quantity
6. Optional- Configure ID
7. Optional- Configure Net Term Days
8. Optional- Configure Start Date
9. Optional- Configure Additional Fields
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 Email on Zoho Mail

Description:Emit new event each time a new email is received

Version:0.0.3

Key:zoho_mail-new-email

View on GitHub

Zoho Mail Overview#

The Zoho Mail API equips you with the ability to automate actions on emails, manage mailboxes, and interact with your Zoho Mail account programmatically. With Pipedream, you can trigger workflows on new emails, send emails automatically, and connect Zoho Mail to thousands of other services, streamlining communication processes, enhancing productivity, and enabling efficient data management.

Trigger Code#

import zohoMail from "../../zoho_mail.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "zoho_mail-new-email",
  name: "New Email",
  description: "Emit new event each time a new email is received",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  props: {
    zohoMail,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      label: "Polling Interval",
      description: "Pipedream will poll the Zoho API on this schedule",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    account: {
      propDefinition: [
        zohoMail,
        "account",
      ],
    },
    max: {
      propDefinition: [
        zohoMail,
        "max",
      ],
    },
  },
  hooks: {
    async deploy() {
      // emit sample events
      let newLastReceivedTime;
      const results = await this.listEmails(10);
      const emails = results.reverse();
      for (const email of emails) {
        this.emitEvent(email);
        if (this.isLater(email.receivedTime, newLastReceivedTime)) {
          newLastReceivedTime = email.receivedTime;
        }
      }
      this._setLastReceivedTime(newLastReceivedTime);
    },
  },
  methods: {
    _getLastReceivedTime() {
      return this.db.get("lastReceivedTime");
    },
    _setLastReceivedTime(lastReceivedTime) {
      this.db.set("lastReceivedTime", lastReceivedTime);
    },
    isLater(receivedTime, lastReceivedTime) {
      return (!lastReceivedTime || parseInt(receivedTime) > parseInt(lastReceivedTime));
    },
    generateMeta(email) {
      return {
        id: email.messageId,
        summary: email.subject,
        ts: Date.parse(email.receivedTime),
      };
    },
    async listEmails(limit) {
      return this.zohoMail.listEmails({
        accountId: this.account,
        params: {
          sortorder: false, // descending
          limit,
        },
      });
    },
    emitEvent(email) {
      const meta = this.generateMeta(email);
      this.$emit(email, meta);
    },
  },
  async run() {
    const lastReceivedTime = this._getLastReceivedTime();
    let newLastReceivedTime = lastReceivedTime;
    const results = await this.listEmails(this.max);
    const emails = results.reverse();
    for (const email of emails) {
      if (this.isLater(email.receivedTime, lastReceivedTime)) {
        if (this.isLater(email.receivedTime, newLastReceivedTime)) {
          newLastReceivedTime = email.receivedTime;
        }
        this.emitEvent(email);
      }
    }

    this._setLastReceivedTime(newLastReceivedTime);
  },
};

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 Mail	`zohoMail`	`app`	This component uses the Zoho Mail app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the Zoho API on this schedule
Account ID	`account`	`string`	Select a value from the drop down menu.
Max	`max`	`integer`	Maximum number of emails to return at one time. Defaults to 10 if left blank.

Trigger Authentication#

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

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

ZohoMail.accounts.readZohoMail.accounts.updateZohoMail.organization.subscriptions.readZohoMail.organization.subscriptions.updateZohoMail.organization.spam.readZohoMail.organization.accounts.readZohoMail.organization.accounts.createZohoMail.organization.accounts.updateZohoMail.messages.createZohoMail.messages.readZohoMail.messages.updateZohoMail.messages.deleteZohoMail.attachments.createZohoMail.attachments.readZohoMail.attachments.updateZohoMail.attachments.deleteZohoMail.organization.groups.createZohoMail.organization.groups.readZohoMail.organization.groups.updateZohoMail.organization.groups.deleteZohoMail.tags.createZohoMail.tags.readZohoMail.tags.updateZohoMail.tags.deleteZohoMail.folders.createZohoMail.folders.readZohoMail.folders.updateZohoMail.folders.deleteZohoMail.organization.domains.createZohoMail.organization.domains.readZohoMail.organization.domains.updateZohoMail.organization.domains.deleteZohoMail.tasks.createZohoMail.tasks.readZohoMail.notes.all

About Zoho Mail#

Zoho Mail offers secure business email for your organization. Host your business email on a secure, encrypted, privacy-guaranteed, and ad-free email service, and add a professional touch to every email that goes out.

Action#

Create Subscription on Chargebee

Description:Create a new subscription for an existing customer. [See the documentation](https://apidocs.chargebee.com/docs/api/subscriptions?lang=curl#create_subscription_for_items)

Version:0.0.2

Key:chargebee-create-subscription

View on GitHub

Chargebee Overview#

The Chargebee API provides a suite of powerful endpoints that facilitate automation around subscription billing, invoicing, and customer management. By leveraging this API on Pipedream, you can build complex, event-driven workflows that react to subscription changes, automate billing operations, sync customer data across platforms, and trigger personalized communication, all without managing servers.

Action Code#

import chargebee from "../../chargebee.app.mjs";
import { clearObject } from "../../common/utils.mjs";

export default {
  key: "chargebee-create-subscription",
  name: "Create Subscription",
  description: "Create a new subscription for an existing customer. [See the documentation](https://apidocs.chargebee.com/docs/api/subscriptions?lang=curl#create_subscription_for_items)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    chargebee,
    customerId: {
      propDefinition: [
        chargebee,
        "customerId",
      ],
    },
    itemPriceId: {
      propDefinition: [
        chargebee,
        "itemPriceId",
      ],
    },
    unitPrice: {
      type: "integer",
      label: "Unit Price",
      description: "The unit price of the plan item.",
    },
    quantity: {
      type: "integer",
      label: "Quantity",
      description: "The quantity of the plan item.",
    },
    id: {
      type: "string",
      label: "ID",
      description: "A unique and immutable identifier for the subscription. If not provided, it is autogenerated.",
      optional: true,
    },
    netTermDays: {
      type: "integer",
      label: "Net Term Days",
      description: "Defines [Net D](https://www.chargebee.com/docs/net_d.html?_gl=1*1w075xz*_gcl_au*MTU4NzU2NDYzOC4xNzMzODA0OTYw) for the subscription. Net D is the number of days within which any invoice raised for the subscription must be paid.",
      optional: true,
    },
    startDate: {
      type: "string",
      label: "Start Date",
      description: "The date/time at which the subscription is to start, e.g. `2024-08-15T09:30:00Z`. If not provided, the subscription starts immediately.",
      optional: true,
    },
    additionalFields: {
      type: "object",
      label: "Additional Fields",
      description: "Additional fields and values to set for the subscription. [See the documentation](https://apidocs.chargebee.com/docs/api/subscriptions?lang=curl#create_subscription_for_items) for all available fields.",
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const response = await this.chargebee.createSubscription(this.customerId, clearObject({
        id: this.id,
        net_term_days: this.netTermDays,
        start_date: this.startDate && (Date.parse(this.startDate) / 1000),
        subscription_items: [
          {
            item_price_id: this.itemPriceId,
            item_type: "plan",
            unit_price: this.unitPrice,
            quantity: this.quantity,
          },
        ],
        ...this.additionalFields,
      }));

      $.export("$summary", `Successfully created subscription (ID: ${response?.subscription?.id})`);
      return response;
    } catch (error) {
      $.export("debug", error);
      throw new Error(`Error creating subscription: ${error.message}`);
    }
  },
};

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
Chargebee	`chargebee`	`app`	This component uses the Chargebee app.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Plan Item Price ID	`itemPriceId`	`string`	Select a value from the drop down menu.
Unit Price	`unitPrice`	`integer`	The unit price of the plan item.
Quantity	`quantity`	`integer`	The quantity of the plan item.
ID	`id`	`string`	A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
Net Term Days	`netTermDays`	`integer`	Defines Net D for the subscription. Net D is the number of days within which any invoice raised for the subscription must be paid.
Start Date	`startDate`	`string`	The date/time at which the subscription is to start, e.g. `2024-08-15T09:30:00Z`. If not provided, the subscription starts immediately.
Additional Fields	`additionalFields`	`object`	Additional fields and values to set for the subscription. See the documentation for all available fields.

Try it

Send Email with Zoho Mail API on Customer Card Expired (Instant) from Chargebee API

Chargebee + Zoho Mail

Try it

Create Task with Zoho Mail API on Customer Changed (Instant) from Chargebee API

Chargebee + Zoho Mail

Try it

Send Email with Zoho Mail API on Customer Changed (Instant) from Chargebee API

Chargebee + Zoho Mail

Try it

Create Task with Zoho Mail API on New Invoice Created (Instant) from Chargebee API

Chargebee + Zoho Mail

Try it

Popular Triggers#

New Email from the Zoho Mail API

Emit new event each time a new email is received

Try it

Customer Card Expired (Instant) from the Chargebee API

Emit new event when a customer card has expired. See the Documentation. Please make sure once you deploy this source, you copy/paste the webhook URL to create it in your Chargebee Webhook settings

Try it

Customer Changed (Instant) from the Chargebee API

Emit new event when a customer is changed. See the Documentation. Please make sure once you deploy this source, you copy/paste the webhook URL to create it in your Chargebee Webhook settings

Try it

New Customer Created (Instant) from the Chargebee API

Emit new event when a new customer is created. See the Documentation. Please make sure once you deploy this source, you copy/paste the webhook URL to create it in your Chargebee Webhook settings

Try it

New Event (Instant) from the Chargebee API

Emit new event when the selected event is triggered. See the Documentation. Please make sure once you deploy this source, you copy/paste the webhook URL to create it in your Chargebee Webhook settings

Try it