Identify a user, tie them to their actions and record traits about them with Segment API on New Payment Failure from Zoho Billing API

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

Trigger workflow on

New Payment Failure from the Zoho Billing API

Next, do this

Identify a user, tie them to their actions and record traits about them with the Segment 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 Billing trigger and Segment 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 Billing account
2. Configure Polling interval
3. Select a Organization Id
Configure the Identify a user, tie them to their actions and record traits about them action
1. Connect your Segment account
2. Optional- Configure Anonymous ID
3. Optional- Configure Context
4. Optional- Configure Integrations
5. Optional- Configure Timestamp
6. Optional- Configure Traits
7. Optional- Configure User 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 Payment Failure on Zoho Billing

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

Version:0.0.2

Key:zoho_subscriptions-payment-failure

View on GitHub

Zoho Billing 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.2",
  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 Billing	`zohoSubscriptions`	`app`	This component uses the Zoho Billing 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 Billing uses OAuth authentication. When you connect your Zoho Billing account, Pipedream will open a popup window where you can sign into Zoho Billing 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 Billing API.

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

ZohoSubscriptions.fullaccess.all

About Zoho Billing#

Subscription billing software, crafted for growing businesses.

Action#

Identify a user, tie them to their actions and record traits about them on Segment

Description:Identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#identify)

Version:0.2.5

Key:segment-identify

View on GitHub

Segment Overview#

The Segment API enables you to collect, manage, and route your customer analytics data to various tools for marketing, analytics, and data warehousing. By harnessing the Segment API on Pipedream, you can automate the ingestion and syncing of user events and properties to multiple destinations, allowing you to create seamless data pipelines without manual intervention. Pipedream's serverless platform empowers you to build custom workflows that react to events in real-time, enrich data, or trigger actions across your tech stack.

Action Code#

import segmentApp from "../../segment.app.mjs";

export default {
  key: "segment-identify",
  name: "Identify a user, tie them to their actions and record traits about them",
  description: "Identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#identify)",
  version: "0.2.5",
  type: "action",
  props: {
    segmentApp,
    anonymousId: {
      propDefinition: [
        segmentApp,
        "anonymousId",
      ],
    },
    context: {
      propDefinition: [
        segmentApp,
        "context",
      ],
    },
    integrations: {
      propDefinition: [
        segmentApp,
        "integrations",
      ],
    },
    timestamp: {
      propDefinition: [
        segmentApp,
        "timestamp",
      ],
    },
    traits: {
      type: "object",
      label: "Traits",
      description: "Free-form dictionary of traits of the user, like email or name.",
      optional: true,
    },
    userId: {
      propDefinition: [
        segmentApp,
        "userId",
      ],
    },
  },
  async run({ $ }) {
    return this.segmentApp.identify({
      $,
      data: {
        anonymousId: this.anonymousId,
        context: this.context,
        integrations: this.integrations,
        timestamp: this.timestamp,
        traits: this.traits,
        userId: this.userId,
      },
    });
  },
};

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
Segment	`segmentApp`	`app`	This component uses the Segment app.
Anonymous ID	`anonymousId`	`string`	A pseudo-unique substitute for a User ID, for cases when you don't have an absolutely unique identifier. A User ID or an Anonymous ID is required.
Context	`context`	`object`	Dictionary of extra information that provides useful context about a message, but is not directly related to the API call like ip address or locale
Integrations	`integrations`	`object`	Dictionary of destinations to either enable or disable
Timestamp	`timestamp`	`string`	Timestamp when the message itself took place, defaulted to the current time by the Segment Tracking API. It is an ISO-8601 date string. For example, `2022-04-08T17:32:11.318Z`
Traits	`traits`	`object`	Free-form dictionary of traits of the user, like email or name.
User ID	`userId`	`string`	Unique identifier for the user in your database., A User ID or an Anonymous ID is required.

Action Authentication#

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

Segment's APIs are accessed programmatically using access tokens, as well as write keys.

Access Token

Create access tokens via the Access Management page in your account: https://app.segment.com/{your-workspace-name}/settings/access-management. See "Get a Token" for more details. Please note, that you must be on a Team or Business plan to create an access token.

Write Key

You will also need to find your write key, which is a unique identifier for your Source. To find a write key, you first need to create a non-Cloud Source such as a website, server, or mobile source. (Cloud-sources do not have write keys, as they use a token or key from your account with that service.) Then, in the Source, go to “Settings’, and then go to “API Keys”. See "Locating Your Write Key" for more details.

About Segment#

Customer data platform

More Ways to Connect Segment + Zoho Billing#

Other Popular Integrations#

Create Customer with Zoho Billing API on Webhook Destination (Instant) from Segment API

Segment + Zoho Billing

Try it

Create Subscription with Zoho Billing API on Webhook Destination (Instant) from Segment API

Segment + Zoho Billing

Try it

Associate one identity with another with Segment API on New Payment Failure from Zoho Billing API

Zoho Billing + Segment

Try it

Associate an identified user with a group with Segment API on New Payment Failure from Zoho Billing API

Zoho Billing + Segment

Try it

Record page views on your website with Segment API on New Payment Failure from Zoho Billing API

Zoho Billing + Segment

Try it

Popular Triggers#

New Payment Failure from the Zoho Billing API

Emit new event when a payment fails to process.

Try it

New Subscription Created from the Zoho Billing API

Emit new event when a new subscription is created.

Try it

Webhook Destination (Instant) from the Segment API

Send events to a webhook. Requires a Team or Business account.

Try it

Popular Actions#

Create Customer with the Zoho Billing API

Create a new customer. See the documentation

Try it

Create Subscription with the Zoho Billing API

Create a new subscription. See the documentation

Try it

Associate an identified user with a group with the Segment API

Group lets you associate an identified user with a group (note requires userId or anonymousId). See the docs here

Try it

Associate one identity with another with the Segment API

Alias is how you associate one identity with another. See the docs here

Try it

Identify a user, tie them to their actions and record traits about them with the Segment API

Identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them (note requires userId or anonymousId). See the docs here

Try it