Churn Subscription with ProfitWell API on New Generation Image Update (Instant) from All-Images.ai API

Pipedream makes it easy to connect APIs for ProfitWell, All-Images.ai and 2,700+ other apps remarkably fast.

Trigger workflow on

New Generation Image Update (Instant) from the All-Images.ai 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 All-Images.ai 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 Generation Image Update (Instant) trigger
1. Connect your All-Images.ai account
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 Generation Image Update (Instant) on All-Images.ai

Description:Emit new event when the generation status of an image gets updated.

Version:0.0.1

Key:all_images_ai-new-generation-image-update-instant

View on GitHub

All-Images.ai Overview#

The All-Images.ai API serves as a tool for processing images through AI-driven methods. With this API, you can enhance images, deblur them, remove backgrounds, and much more. All-Images.ai becomes more powerful when integrated into Pipedream’s serverless platform, allowing you to automate image processing in workflows that connect with other apps. You can trigger workflows with HTTP requests, email, and over 800 Pipedream-supported apps. These automations can save time and enhance productivity, especially for tasks involving bulk image processing or real-time image manipulation.

Trigger Code#

import allImagesAi from "../../all_images_ai.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "all_images_ai-new-generation-image-update-instant",
  name: "New Generation Image Update (Instant)",
  description: "Emit new event when the generation status of an image gets updated.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    allImagesAi,
    db: "$.service.db",
    http: "$.interface.http",
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
  },
  hooks: {
    async activate() {
      const { webhookId } = await this.allImagesAi.createWebhook({
        data: {
          url: this.http.endpoint,
          events: [
            "print.created",
            "print.active",
            "print.progress",
            "print.failed",
            "print.completed",
          ],
        },
      });
      this._setHookId(webhookId);
    },
    async deactivate() {
      const hookId = this._getHookId();
      await this.allImagesAi.deleteWebhook(hookId);
    },
  },
  async run({ body }) {
    this.$emit(body, {
      id: body.id,
      summary: `Image generation status updated for image ID: ${body.type}`,
      ts: Date.parse(body.created),
    });
  },
  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
All-Images.ai	`allImagesAi`	`app`	This component uses the All-Images.ai 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.

Trigger Authentication#

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

About All-Images.ai#

Take advantage of unique, original, exclusive, personalized and royalty-free visuals for all your projects.

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,