Remove Background with DeepImage API on New Coupon Event (Instant) from WooCommerce API

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

Trigger workflow on

New Coupon Event (Instant) from the WooCommerce API

Next, do this

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

Select this integration
Configure the New Coupon Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Remove Background action
1. Connect your DeepImage account
2. Configure Image
3. Select a Background Color
4. Optional- Select a Crop 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 Coupon Event (Instant) on WooCommerce

Description:Emit new event each time the specified coupon event(s) occur

Version:0.0.3

Key:woocommerce-new-coupon-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "woocommerce-new-coupon-event",
  name: "New Coupon Event (Instant)",
  description: "Emit new event each time the specified coupon event(s) occur",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listCoupons({
        per_page: perPage,
        orderby: "date",
      });
    },
    getTopic(topicType) {
      return `coupon.${topicType}`;
    },
    generateMeta(eventType, {
      id, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Coupon ID: ${id} ${eventType}`,
        ts,
      };
    },
  },
};

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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce 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 topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

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

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Remove Background on DeepImage

Description:Removes the background from the provided image using DeepImage. [See the documentation](https://documentation.deep-image.ai/image-processing/background-processing)

Version:0.0.1

Key:deepimage-remove-background

View on GitHub

Action Code#

import {
  BACKGROUND_COLOR_OPTIONS, CROP_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import { getUrlOrFile } from "../../common/utils.mjs";
import deepimage from "../../deepimage.app.mjs";

export default {
  key: "deepimage-remove-background",
  name: "Remove Background",
  description: "Removes the background from the provided image using DeepImage. [See the documentation](https://documentation.deep-image.ai/image-processing/background-processing)",
  version: "0.0.1",
  type: "action",
  props: {
    deepimage,
    image: {
      propDefinition: [
        deepimage,
        "image",
      ],
    },
    backgroundColor: {
      type: "string",
      label: "Background Color",
      description: "The background color for the image.",
      options: BACKGROUND_COLOR_OPTIONS,
    },
    cropType: {
      type: "string",
      label: "Crop Type",
      description: "The crop type for background removal.",
      optional: true,
      options: CROP_TYPE_OPTIONS,
    },
  },
  async run({ $ }) {
    const response = await this.deepimage.makeRequest({
      $,
      data: {
        url: getUrlOrFile(this.image),
        background: {
          remove: "auto",
          color: this.backgroundColor,
        },
        fit: this.cropType
          ? {
            crop: this.cropType,
          }
          : {},
      },
    });

    $.export("$summary", "Background removal successful");
    return response;
  },
};

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
DeepImage	`deepimage`	`app`	This component uses the DeepImage app.
Image	`image`	`string`	The URL of the image or the path to the file saved to the `/tmp` directory (e.g. `/tmp/example.jpg`) to process. See the documentation.
Background Color	`backgroundColor`	`string`	Select a value from the drop down menu:`{ "label": "White", "value": "#FFFFFF" }{ "label": "Transparent", "value": "transparent" }`
Crop Type	`cropType`	`string`	Select a value from the drop down menu:`{ "label": "Crop center", "value": "center" }{ "label": "Crop item", "value": "item" }{ "label": "Crop content", "value": "content" }{ "label": "Cover", "value": "cover" }{ "label": "Canvas", "value": "canvas" }{ "label": "Bounds", "value": "bounds" }`