Create a Subscription with Pipedream API on New Subscription Created from Zoho Subscriptions API

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

Trigger workflow on

New Subscription Created from the Zoho Subscriptions API

Next, do this

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

Select this integration
Configure the New Subscription Created trigger
1. Connect your Zoho Subscriptions account
2. Configure Polling interval
3. Select a Organization Id
Configure the Create a Subscription action
1. Connect your Pipedream account
2. Select a Subscription category
3. Select a Subscription source
4. Optional- Select a Event name
5. Configure Listener ID
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 Subscription Created on Zoho Subscriptions

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

Version:0.0.1

Key:zoho_subscriptions-subscription-created

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-subscription-created",
  name: "New Subscription Created",
  version: "0.0.1",
  description: "Emit new event when a new subscription is created.",
  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: "subscription_created",
          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,
        });

        event.event.payload = JSON.parse(event.event.payload);

        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#

Create a Subscription on Pipedream

Description:Create a Subscription. [See Doc](https://pipedream.com/docs/api/rest/#subscriptions)

Version:0.1.0

Key:pipedream-create-subscription

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Action Code#

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

export default {
  key: "pipedream-create-subscription",
  name: "Create a Subscription",
  description: "Create a Subscription. [See Doc](https://pipedream.com/docs/api/rest/#subscriptions)",
  version: "0.1.0",
  type: "action",
  props: {
    pipedream,
    subscriptionCategory: {
      propDefinition: [
        pipedream,
        "subscriptionCategory",
      ],
    },
    subscriptionSource: {
      propDefinition: [
        pipedream,
        "subscriptionSource",
        (c) => ({
          subscriptionCategory: c.subscriptionCategory,
        }),
      ],
    },
    eventName: {
      propDefinition: [
        pipedream,
        "eventName",
      ],
    },
    listenerId: {
      propDefinition: [
        pipedream,
        "listenerId",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.pipedream
      .subscribe(this.subscriptionSource, this.listenerId, this.eventName);
    response?.data?.length > 0 && $.export("$summary", "Successfully created Subscription");
    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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Subscription category	`subscriptionCategory`	`string`	Select a value from the drop down menu:`OrganisationUserGlob patterns`
Subscription source	`subscriptionSource`	`string`	Select a value from the drop down menu.
Event name	`eventName`	`string`	Select a value from the drop down menu:`$errors$logs`
Listener ID	`listenerId`	`string`	The ID of the component or workflow you'd like to receive events

Action Authentication#

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

About Pipedream#

Integration platform for developers

More Ways to Connect Pipedream + Zoho Subscriptions#

Other Popular Integrations#

Create Customer with Zoho Subscriptions API on New Scheduled Tasks from Pipedream API

Pipedream + Zoho Subscriptions

Create a Subscription with Pipedream API on New Subscription Created from Zoho Subscriptions API

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

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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