Image Background Removal with Runware API on New Customer Created (Instant) from Shopify API

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

Trigger workflow on

New Customer Created (Instant) from the Shopify API

Next, do this

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

Select this integration
Configure the New Customer Created (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Image Background Removal action
1. Connect your Runware account
2. Configure Input Image
3. Optional- Select a Output Type
4. Optional- Select a Output Format
5. Optional- Configure Include Cost
6. Optional- Configure RGB
7. Optional- Configure Post-Process Mask
8. Optional- Configure Return Only Mask
9. Optional- Configure Alpha Matting
10. Optional- Configure Alpha Matting Foreground Threshold
11. Optional- Configure Alpha Matting Background Threshold
12. Optional- Configure Alpha Matting Erode Size
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 Customer Created (Instant) on Shopify

Description:Emit new event for each new customer added to a store.

Version:0.0.4

Key:shopify_developer_app-new-customer-created

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Trigger Code#

import constants from "../common/constants.mjs";
import common from "../common/webhook-metafields.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-customer-created",
  name: "New Customer Created (Instant)",
  type: "source",
  description: "Emit new event for each new customer added to a store.",
  version: "0.0.4",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.CUSTOMERS_CREATE;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.created_at);
      return {
        id: resource.id,
        summary: `New Customer ${resource.id}.`,
        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
Shopify	`app`	`app`	This component uses the Shopify 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.
Metafield Namespaces	`metafieldNamespaces`	`string[]`	Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.

Trigger Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

Action#

Image Background Removal on Runware

Description:Request an image background removal task to be processed by the Runware API. [See the documentation](https://docs.runware.ai/en/image-editing/background-removal).

Version:0.0.1

Key:runware-image-background-removal

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { v4 as uuid } from "uuid";
import app from "../../runware.app.mjs";
import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "runware-image-background-removal",
  name: "Image Background Removal",
  description: "Request an image background removal task to be processed by the Runware API. [See the documentation](https://docs.runware.ai/en/image-editing/background-removal).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    inputImage: {
      propDefinition: [
        app,
        "inputImage",
      ],
    },
    outputType: {
      propDefinition: [
        app,
        "outputType",
      ],
    },
    outputFormat: {
      propDefinition: [
        app,
        "outputFormat",
      ],
    },
    includeCost: {
      propDefinition: [
        app,
        "includeCost",
      ],
    },
    rgb: {
      type: "string[]",
      label: "RGB",
      description: "An array representing the `[red, green, blue]` values that define the color of the removed background. Eg. `[255, 255, 255]`.",
      optional: true,
    },
    postProcessMask: {
      type: "boolean",
      label: "Post-Process Mask",
      description: "Flag indicating whether to post-process the mask. Controls whether the mask should undergo additional post-processing. This step can improve the accuracy and quality of the background removal mask.",
      optional: true,
    },
    returnOnlyMask: {
      type: "boolean",
      label: "Return Only Mask",
      description: "Flag indicating whether to return only the mask. The mask is the opposite of the image background removal.",
      optional: true,
    },
    alphaMatting: {
      type: "boolean",
      label: "Alpha Matting",
      description: "Flag indicating whether to use alpha matting. Alpha matting is a post-processing technique that enhances the quality of the output by refining the edges of the foreground object.",
      optional: true,
    },
    alphaMattingForegroundThreshold: {
      type: "integer",
      label: "Alpha Matting Foreground Threshold",
      description: "Threshold value used in alpha matting to distinguish the foreground from the background. Adjusting this parameter affects the sharpness and accuracy of the foreground object edges. Eg. `240`.",
      optional: true,
      min: 1,
      max: 255,
    },
    alphaMattingBackgroundThreshold: {
      type: "integer",
      label: "Alpha Matting Background Threshold",
      description: "Threshold value used in alpha matting to refine the background areas. It influences how aggressively the algorithm removes the background while preserving image details. The higher the value, the more computation is needed and therefore the more expensive the operation is. Eg. `10`.",
      optional: true,
      min: 1,
      max: 255,
    },
    alphaMattingErodeSize: {
      type: "integer",
      label: "Alpha Matting Erode Size",
      description: "Specifies the size of the erosion operation used in alpha matting. Erosion helps in smoothing the edges of the foreground object for a cleaner removal of the background. Eg. `10`.",
      optional: true,
      min: 1,
      max: 255,
    },
  },
  methods: {
    getRGBA(rgb, alpha = 0) {
      if (rgb) {
        const parsed = utils.parseArray(rgb).map((value) => parseInt(value, 10));
        return parsed.concat(alpha);
      }
    },
  },
  async run({ $ }) {
    const {
      app,
      getRGBA,
      inputImage,
      outputType,
      outputFormat,
      includeCost,
      rgb,
      postProcessMask,
      returnOnlyMask,
      alphaMatting,
      alphaMattingForegroundThreshold,
      alphaMattingBackgroundThreshold,
      alphaMattingErodeSize,
    } = this;

    if (rgb && utils.parseArray(rgb).length !== 3) {
      throw new ConfigurationError("The **RGB** array must contain exactly 3 integer numbers. Eg. `[255, 255, 255]`.");
    }

    const response = await app.post({
      $,
      data: [
        {
          taskType: constants.TASK_TYPE.IMAGE_BACKGROUND_REMOVAL.value,
          taskUUID: uuid(),
          inputImage,
          outputType,
          outputFormat,
          includeCost,
          rgba: getRGBA(rgb),
          postProcessMask,
          returnOnlyMask,
          alphaMatting,
          alphaMattingForegroundThreshold,
          alphaMattingBackgroundThreshold,
          alphaMattingErodeSize,
        },
      ],
    });

    $.export("$summary", `Successfully requested image background removal task with UUID \`${response.data[0].taskUUID}\`.`);
    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
Runware	`app`	`app`	This component uses the Runware app.
Input Image	`inputImage`	`string`	Specifies the input image to be processed. The image can be specified in one of the following formats: An UUID v4 string of a previously uploaded image or a generated image. A data URI string representing the image. The data URI must be in the format `data:<mediaType>;base64,` followed by the base64-encoded image. For example: `data:image/png;base64,iVBORw0KGgo...`. A base64 encoded image without the data URI prefix. For example: `iVBORw0KGgo...`. A URL pointing to the image. The image must be accessible publicly. Supported formats are: PNG, JPG and WEBP.
Output Type	`outputType`	`string`	Select a value from the drop down menu:`base64DatadataURIURL`
Output Format	`outputFormat`	`string`	Select a value from the drop down menu:`PNGJPGWEBP`
Include Cost	`includeCost`	`boolean`	If set to `true`, the cost to perform the task will be included in the response object. Defaults to `false`.
RGB	`rgb`	`string[]`	An array representing the `[red, green, blue]` values that define the color of the removed background. Eg. `[255, 255, 255]`.
Post-Process Mask	`postProcessMask`	`boolean`	Flag indicating whether to post-process the mask. Controls whether the mask should undergo additional post-processing. This step can improve the accuracy and quality of the background removal mask.
Return Only Mask	`returnOnlyMask`	`boolean`	Flag indicating whether to return only the mask. The mask is the opposite of the image background removal.
Alpha Matting	`alphaMatting`	`boolean`	Flag indicating whether to use alpha matting. Alpha matting is a post-processing technique that enhances the quality of the output by refining the edges of the foreground object.
Alpha Matting Foreground Threshold	`alphaMattingForegroundThreshold`	`integer`	Threshold value used in alpha matting to distinguish the foreground from the background. Adjusting this parameter affects the sharpness and accuracy of the foreground object edges. Eg. `240`.
Alpha Matting Background Threshold	`alphaMattingBackgroundThreshold`	`integer`	Threshold value used in alpha matting to refine the background areas. It influences how aggressively the algorithm removes the background while preserving image details. The higher the value, the more computation is needed and therefore the more expensive the operation is. Eg. `10`.
Alpha Matting Erode Size	`alphaMattingErodeSize`	`integer`	Specifies the size of the erosion operation used in alpha matting. Erosion helps in smoothing the edges of the foreground object for a cleaner removal of the background. Eg. `10`.

Image Background Removal with Runware API on New Customer Created (Instant) from Shopify API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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