[Data] Convert JSON to String with Formatting API on New Event from Chargebee API

Pipedream makes it easy to connect APIs for Formatting, Chargebee and 2,400+ other apps remarkably fast.

Trigger workflow on

New Event from the Chargebee API

Next, do this

[Data] Convert JSON to String with the Formatting 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 Chargebee trigger and Formatting action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Event trigger
1. Connect your Chargebee account
2. Select one or more Event Type
Configure the [Data] Convert JSON to String action
1. Connect your Formatting account
2. Configure Input
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 Event on Chargebee

Description:Emit new event when the selected event is triggered. [See the Documentation](https://apidocs.chargebee.com/docs/api/events). Please make sure once you deploy this source, you copy/paste the webhook URL to create it in your [Chargebee Webhook settings](https://www.chargebee.com/docs/2.0/webhook_settings.html#configure-webhooks).

Version:0.0.2

Key:chargebee-new-event

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.

Trigger Code#

import constants from "../../common/constants.mjs";
import events from "../common/events.mjs";
import common from "../common/webhook.mjs";

export default {
  ...common,
  key: "chargebee-new-event",
  name: "New Event",
  description: "Emit new event when the selected event is triggered. [See the Documentation](https://apidocs.chargebee.com/docs/api/events). Please make sure once you deploy this source, you copy/paste the webhook URL to create it in your [Chargebee Webhook settings](https://www.chargebee.com/docs/2.0/webhook_settings.html#configure-webhooks).",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  props: {
    ...common.props,
    eventType: {
      type: "string[]",
      label: "Event Type",
      description: "Select the type of the event you want to receive.",
      options: Object.keys(events).map((key) => events[key]),
    },
  },
  methods: {
    ...common.methods,
    getEventTypes() {
      return this.eventType;
    },
    async getResources() {
      const { list } = await this.app.getEvents({
        "limit": constants.MAX_LIMIT,
        "sort_by[desc]": "occurred_at",
      });
      return list;
    },
    generateMeta(event) {
      return {
        id: event.id,
        summary: `New Event Triggered: ${event.id}`,
        ts: event.occurred_at,
      };
    },
  },
};

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
Chargebee	`app`	`app`	This component uses the Chargebee app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Event Type	`eventType`	`string[]`	Select a value from the drop down menu:`coupon_createdcoupon_updatedcoupon_deletedcoupon_set_createdcoupon_set_updatedcoupon_set_deletedcoupon_codes_addedcoupon_codes_deletedcoupon_codes_updatedcustomer_createdcustomer_changedcustomer_deletedcustomer_moved_outcustomer_moved_inpromotional_credits_addedpromotional_credits_deductedsubscription_createdsubscription_created_with_backdatingsubscription_startedsubscription_trial_end_remindersubscription_activatedsubscription_activated_with_backdatingsubscription_changedsubscription_trial_extendedmrr_updatedsubscription_changed_with_backdatingsubscription_cancellation_scheduledsubscription_cancellation_remindersubscription_cancelledsubscription_canceled_with_backdatingsubscription_reactivatedsubscription_reactivated_with_backdatingsubscription_renewedsubscription_scheduled_cancellation_removedsubscription_shipping_address_updatedsubscription_deletedsubscription_pausedsubscription_pause_scheduledsubscription_scheduled_pause_removedsubscription_resumedsubscription_resumption_scheduledsubscription_scheduled_resumption_removedsubscription_advance_invoice_schedule_addedsubscription_advance_invoice_schedule_updatedsubscription_advance_invoice_schedule_removedpending_invoice_createdpending_invoice_updatedinvoice_generatedinvoice_generated_with_backdatinginvoice_updatedinvoice_deletedcredit_note_createdcredit_note_created_with_backdatingcredit_note_updatedcredit_note_deletedsubscription_renewal_reminderadd_usages_remindertransaction_createdtransaction_updatedtransaction_deletedpayment_succeededpayment_failedpayment_refundedpayment_initiatedrefund_initiatedauthorization_succeededauthorization_voidedcard_addedcard_updatedcard_expiry_remindercard_expiredcard_deletedpayment_source_addedpayment_source_updatedpayment_source_deletedpayment_source_expiringpayment_source_expiredvirtual_bank_account_addedvirtual_bank_account_updatedvirtual_bank_account_deletedtoken_createdtoken_consumedtoken_expiredunbilled_charges_createdunbilled_charges_voidedunbilled_charges_deletedunbilled_charges_invoicedorder_createdorder_updatedorder_cancelledorder_deliveredorder_returnedorder_ready_to_processorder_ready_to_shiporder_deletedorder_resentquote_createdquote_updatedquote_deletedtax_withheld_recordedtax_withheld_deletedtax_withheld_refundedgift_scheduledgift_unclaimedgift_claimedgift_expiredgift_cancelledgift_updatedhierarchy_createdhierarchy_deletedpayment_intent_createdpayment_intent_updatedcontract_term_createdcontract_term_renewedcontract_term_terminatedcontract_term_completedcontract_term_cancelleditem_family_createditem_family_updateditem_family_deleteditem_createditem_updateditem_deleteditem_price_createditem_price_updateditem_price_deletedattached_item_createdattached_item_updatedattached_item_deleteddifferential_price_createddifferential_price_updateddifferential_price_deletedfeature_createdfeature_updatedfeature_deletedfeature_activatedfeature_reactivatedfeature_archiveditem_entitlements_updatedentitlement_overrides_updatedentitlement_overrides_removedimpacted_subscriptionitem_entitlements_removedentitlement_overrides_auto_removedsubscription_entitlements_createdbusiness_entity_createdbusiness_entity_updatedbusiness_entity_deletedpurchase_createdvoucher_createdvoucher_expiredvoucher_create_failedproduct_createdproduct_updatedproduct_deletedvariant_createdvariant_updatedvariant_deleted`

Trigger Authentication#

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

The API key could be got from Your API Keys page under integration tab in the web client console.
You sub_url is here https://[sub_url].chargebee.com/

About Chargebee#

Automated Subscription Billing Software

Action#

[Data] Convert JSON to String on Formatting

Description:Convert an object to a JSON format string

Version:0.0.5

Key:formatting-convert-json-to-string

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Data] Convert JSON to String",
    description: "Convert an object to a JSON format string",
    key: "formatting-convert-json-to-string",
    version: "0.0.5",
    type: "action",
    props: {
        app,
        input: {
            label: "Input",
            description: "An object to be serialized to a JSON format string.",
            type: "object",
        },
    },
    async run({ $ }) {
        try {
            const result = JSON.stringify(this.input);
            $.export("$summary", "Successfully convert object to JSON string");
            return result;
        }
        catch (err) {
            throw new Error("Error serializing object to JSON string: " + err.toString());
        }
    },
});

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
Formatting	`app`	`app`	This component uses the Formatting app.
Input	`input`	`object`	An object to be serialized to a JSON format string.

Action Authentication#

The Formatting API does not require authentication.

About Formatting#

Pre-built actions to make formatting and manipulating data within your workflows easier.

More Ways to Connect Formatting + Chargebee#

Other Popular Integrations#

[Date/Time] Add/Subtract Time with Formatting API on Customer Card Expired (Instant) from Chargebee API

Chargebee + Formatting

[Data] Convert JSON to String with Formatting API on New Event from Chargebee API

Pipedream makes it easy to connect APIs for Formatting, Chargebee and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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