Churn Subscription with ProfitWell API on New Deal Property Change from HubSpot API

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

Trigger workflow on

New Deal Property Change from the HubSpot 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 HubSpot 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 Deal Property Change trigger
1. Connect your HubSpot account
2. Configure timer
3. Select a Property
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 Deal Property Change on HubSpot

Description:Emit new event when a specified property is provided or updated on a deal. [See the documentation](https://developers.hubspot.com/docs/api/crm/deals)

Version:0.0.10

Key:hubspot-new-deal-property-change

View on GitHub

HubSpot Overview#

The HubSpot API enables developers to integrate into HubSpots CRM, CMS, Conversations, and other features. It allows for automated management of contacts, companies, deals, and marketing campaigns, enabling custom workflows, data synchronization, and task automation. This streamlines operations and boosts customer engagement, with real-time updates for rapid response to market changes.

Trigger Code#

import common from "../common/common.mjs";
import { DEFAULT_LIMIT } from "../../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "hubspot-new-deal-property-change",
  name: "New Deal Property Change",
  description: "Emit new event when a specified property is provided or updated on a deal. [See the documentation](https://developers.hubspot.com/docs/api/crm/deals)",
  version: "0.0.10",
  dedupe: "unique",
  type: "source",
  props: {
    ...common.props,
    property: {
      type: "string",
      label: "Property",
      description: "The deal property to watch for changes",
      async options() {
        const properties = await this.hubspot.getDealProperties();
        return properties.map((property) => property.name);
      },
    },
  },
  methods: {
    ...common.methods,
    getTs(deal) {
      const history = deal.propertiesWithHistory[this.property];
      if (!history || !(history.length > 0)) {
        return;
      }
      return Date.parse(history[0].timestamp);
    },
    generateMeta(deal) {
      const { id } = deal;
      const ts = this.getTs(deal);
      return {
        id: `${id}${ts}`,
        summary: `Deal ${id} updated`,
        ts,
      };
    },
    isRelevant(deal, updatedAfter) {
      return !updatedAfter || this.getTs(deal) > updatedAfter;
    },
    getParams(after) {
      return {
        object: "deals",
        data: {
          limit: DEFAULT_LIMIT,
          properties: [
            this.property,
          ],
          sorts: [
            {
              propertyName: "hs_lastmodifieddate",
              direction: "DESCENDING",
            },
          ],
          filterGroups: [
            {
              filters: [
                {
                  propertyName: this.property,
                  operator: "HAS_PROPERTY",
                },
                {
                  propertyName: "hs_lastmodifieddate",
                  operator: "GTE",
                  value: after,
                },
              ],
            },
          ],
        },
      };
    },
    batchGetDeals(inputs) {
      return this.hubspot.batchGetObjects({
        objectType: "deals",
        data: {
          properties: [
            this.property,
          ],
          propertiesWithHistory: [
            this.property,
          ],
          inputs,
        },
      });
    },
    async processResults(after, params) {
      const properties = await this.hubspot.getDealProperties();
      const propertyNames = properties.map((property) => property.name);
      if (!propertyNames.includes(this.property)) {
        throw new Error(`Property "${this.property}" not supported for Deals. See Hubspot's default deal properties documentation - https://knowledge.hubspot.com/crm-deals/hubspots-default-deal-properties`);
      }

      const updatedDeals = await this.getPaginatedItems(this.hubspot.searchCRM, params);

      if (!updatedDeals.length) {
        return;
      }

      const results = await this.processChunks({
        batchRequestFn: this.batchGetDeals,
        chunks: this.getChunks(updatedDeals),
      });

      this.processEvents(results, after);
    },
  },
  sampleEmit,
};

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
HubSpot	`hubspot`	`app`	This component uses the HubSpot app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Property	`property`	`string`	Select a value from the drop down menu.

Trigger Authentication#

HubSpot uses OAuth authentication. When you connect your HubSpot account, Pipedream will open a popup window where you can sign into HubSpot and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any HubSpot API.

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

business-intelligencecrm.lists.readcrm.lists.writecrm.objects.companies.readcrm.objects.companies.writecrm.objects.contacts.readcrm.objects.contacts.writecrm.objects.deals.readcrm.objects.deals.writecrm.objects.quotes.readcrm.objects.quotes.writecrm.objects.owners.readcrm.schemas.companies.readcrm.schemas.companies.writecrm.schemas.contacts.readcrm.schemas.contacts.writecrm.schemas.deals.readcrm.schemas.deals.writecrm.schemas.quotes.readconversations.readcrm.importfilesformsforms-uploaded-filesintegration-syncoauthtimeline

About HubSpot#

HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.

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,

Navigate to your ProfitWell account and sign in
Go to Account Settings > Integrations > ProfitWell API

Churn Subscription with ProfitWell API on New Deal Property Change from HubSpot API

Pipedream makes it easy to connect APIs for ProfitWell, HubSpot 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