Churn Subscription with ProfitWell API on New SMS Received (Instant) from Plivo API

Pipedream makes it easy to connect APIs for ProfitWell, Plivo and 2,700+ other apps remarkably fast.

Trigger workflow on

New SMS Received (Instant) from the Plivo API

Next, do this

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

Select this integration
Configure the New SMS Received (Instant) trigger
1. Connect your Plivo account
2. Select a Phone Number
Configure the Churn Subscription action
1. Connect your ProfitWell account
2. Configure Subscription ID or Alias
3. Configure Effective Date
4. Select a Churn Type
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 SMS Received (Instant) on Plivo

Description:Emit new event when a new SMS is received. [See the docs](https://www.plivo.com/docs/sms/api/message#send-a-message).

Version:0.0.1

Key:plivo-new-sms-received

View on GitHub

Plivo Overview#

The Plivo API taps into the power of cloud communication, allowing you to programmatically send SMS messages, make voice calls, and manage user verifications among other telephony functions. With Pipedream's serverless platform, you can easily integrate Plivo into workflows that automate these communication tasks, react to incoming messages or calls, and connect with numerous other apps for comprehensive automation solutions.

Trigger Code#

import common from "../common/webhook.mjs";
import constants from "../../common/constants.mjs";
import { v4 as uuid } from "uuid";

export default {
  ...common,
  key: "plivo-new-sms-received",
  name: "New SMS Received (Instant)",
  description: "Emit new event when a new SMS is received. [See the docs](https://www.plivo.com/docs/sms/api/message#send-a-message).",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  props: {
    ...common.props,
    phoneNumber: {
      propDefinition: [
        common.props.app,
        "phoneNumber",
      ],
    },
  },
  methods: {
    ...common.methods,
    listMessages(args = []) {
      return this.app.makeRequest({
        path: "messages.list",
        args,
      });
    },
    getResourcesFn() {
      return this.listMessages;
    },
    getResourcesFnArgs() {
      const messageTime = this.getLastMessageTime();
      return messageTime
        ? {
          limit: constants.DEFAULT_LIMIT,
          message_time__gt: messageTime,
        }
        : {
          limit: constants.DEFAULT_LIMIT,
        };
    },
    getPhoneNumber() {
      return this.phoneNumber;
    },
    generateMeta(resource) {
      if (resource.messageUuid) {
        return {
          id: resource.messageUuid,
          ts: Date.parse(resource.messageTime),
          summary: `History SMS received from ${resource.fromNumber}`,
        };
      }
      return {
        id: resource.MessageUUID,
        ts: Date.now(),
        summary: `New SMS received from ${resource.From}`,
      };
    },
    isResourceRelevant(resource) {
      return resource.messageDirection === constants.RESOURCE.MSG.DIRECTION.INBOUND
        && resource.messageState === constants.RESOURCE.MSG.STATUS.DELIVERED
        && resource.messageType === constants.RESOURCE.MSG.TYPE.SMS;
    },
    getApplicationName() {
      return `PipedreamInboundSMS${uuid()}`;
    },
  },
};

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
Plivo	`app`	`app`	This component uses the Plivo 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.
Phone Number	`phoneNumber`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

All requests to Plivo API are authenticated with BasicAuth using your AUTH ID and AUTH TOKEN. Your Plivo AUTH ID and AUTH TOKEN can be found when you login to your dashboard

About Plivo#

SMS API and Voice API platform

Action#

Churn Subscription on ProfitWell

Description:Churn a subscription [See docs here](https://profitwellapiv2.docs.apiary.io/#/reference/manually-added-customers/updating-subscriptions/churn-a-subscription)

Version:0.0.1

Key:profitwell-churn-subscription

View on GitHub

ProfitWell Overview#

The ProfitWell API provides programmatic access to metrics and data related to subscription-based businesses. By integrating with Pipedream, you can automate complex workflows involving your financial metrics, customer insights, and growth tracking. Whether it's syncing subscriber data with marketing platforms, triggering alerts based on revenue milestones, or creating custom analytics dashboards, Pipedream's serverless platform enables you to connect ProfitWell with a plethora of other services without writing extensive code.

Action Code#

import profitwell from "../../app/profitwell.app.mjs";
import { defineAction } from "@pipedream/types";
import { EffectiveDateDescription } from "../../common/propDescriptions.mjs";
export default defineAction({
    name: "Churn Subscription",
    description: "Churn a subscription [See docs here](https://profitwellapiv2.docs.apiary.io/#/reference/manually-added-customers/updating-subscriptions/churn-a-subscription)",
    key: "profitwell-churn-subscription",
    version: "0.0.1",
    type: "action",
    props: {
        profitwell,
        subscriptionIdOrAlias: {
            propDefinition: [
                profitwell,
                "subscriptionIdOrAlias",
            ],
        },
        effectiveDate: {
            propDefinition: [
                profitwell,
                "effectiveDate",
            ],
            description: EffectiveDateDescription("the subscription churns"),
        },
        churnType: {
            type: "string",
            label: "Churn Type",
            options: [
                "voluntary",
                "delinquent",
            ],
            default: "voluntary",
        },
    },
    async run({ $ }) {
        const params = {
            $,
            subscriptionIdOrAlias: this.subscriptionIdOrAlias,
            params: {
                churn_type: this.churnType,
                effective_date: this.profitwell.getUnixTimestamp(this.effectiveDate),
            },
        };
        const data = await this.profitwell.churnSubscription(params);
        const label = this.profitwell.getSubscriptionLabel(data);
        $.export("$summary", `Successfully churned subscription ${label}`);
        return data;
    },
});

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
ProfitWell	`profitwell`	`app`	This component uses the ProfitWell app.
Subscription ID or Alias	`subscriptionIdOrAlias`	`string`	Either the `subscription_id` or `subscription_alias` of the subscription
Effective Date	`effectiveDate`	`string`	UNIX timestamp (in seconds) of when the subscription churns. You can also provide a valid date/time string and Pipedream will automatically convert it to a UNIX timestamp. Examples: `1644933600` `2022-02-15` `2022-02-15T14:00Z`
Churn Type	`churnType`	`string`	Select a value from the drop down menu:`voluntarydelinquent`

Action Authentication#

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

To retrieve your API token,