Run Node Code with Node API on New Payment Failure from Zoho Subscriptions API

Pipedream makes it easy to connect APIs for Node, Zoho Subscriptions and 2,200+ other apps remarkably fast.

Trigger workflow on

New Payment Failure from the Zoho Subscriptions API

Next, do this

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

Select this integration
Configure the New Payment Failure trigger
1. Connect your Zoho Subscriptions account
2. Configure Polling interval
3. Select a Organization Id
Configure the Run Node Code action
1. Connect your Node account
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 Payment Failure on Zoho Subscriptions

Description:Emit new event when a payment fails to process.

Version:0.0.1

Key:zoho_subscriptions-payment-failure

View on GitHub

Zoho Subscriptions Overview#

The Zoho Subscriptions API allows you to manage various aspects of subscription-based billing services. With this API, you can automate tasks such as creating subscriptions, handling customer billing info, and managing invoices. In Pipedream, you can harness this API to build workflows that respond to events in Zoho Subscriptions or to perform actions based on triggers from other apps. This enables seamless automation of billing operations and integration with your broader app ecosystem.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import moment from "moment";
import zohoSubscriptions from "../../zoho_subscriptions.app.mjs";

export default {
  key: "zoho_subscriptions-payment-failure",
  name: "New Payment Failure",
  version: "0.0.1",
  description: "Emit new event when a payment fails to process.",
  type: "source",
  dedupe: "unique",
  props: {
    zohoSubscriptions,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Zoho Subscriptions on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    organizationId: {
      propDefinition: [
        zohoSubscriptions,
        "organizationId",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate");
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent(maxResults) {
      const lastDate = this._getLastDate();
      let responseArray = [];

      const items = this.zohoSubscriptions.paginate({
        fn: this.zohoSubscriptions.listEvents,
        params: {
          event_type: "payment_declined",
          date_start: lastDate || "1970-01-01",
          date_end: moment().format("YYYY-MM-DD"),
        },
        organizationId: this.organizationId,
        maxResults,
      });

      for await (const item of items) {
        responseArray.push(item);
      }

      if (responseArray[0]) {
        this._setLastDate(responseArray[0].event_time);
      }

      for (const responseItem of responseArray.reverse()) {
        const event = await this.zohoSubscriptions.getEvent({
          eventId: responseItem.event_id,
          organizationId: this.organizationId,
        });

        this.$emit(
          event,
          {
            id: responseItem.event_id,
            summary: `New event with id: "${responseItem.event_id}" was created!`,
            ts: new Date(),
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
};

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 Subscriptions	`zohoSubscriptions`	`app`	This component uses the Zoho Subscriptions 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 Subscriptions on this schedule
Organization Id	`organizationId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

ZohoSubscriptions.fullaccess.all

About Zoho Subscriptions#

Subscription billing software, crafted for growing businesses.

Action#

Run Node Code on Node

Description:Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.

Version:0.0.2

Key:node-run-node-code

View on GitHub

Node Overview#

Develop, run and deploy your Node.js code in Pipedream workflows, using it between no-code steps, with connected accounts, or integrate Data Stores and File Stores.

This includes installing NPM packages, within your code without having to manage a package.json file or running npm install.

Below is an example of installing the axios package in a Pipedream Node.js code step. Pipedream imports the axios package, performs the API request, and shares the response with subsequent workflow steps:

Action Code#

import node from "../../node.app.mjs";

export default {
  name: "Run Node Code",
  version: "0.0.2",
  key: "node-run-node-code",
  description: "Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.",
  props: {
    node,
  },
  type: "action",
  methods: {},
  async run({
    steps, $,
  }) {
    // Return data to use it in future steps
    return steps.trigger.event;
  },
};