Compare Image with Diffchecker API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

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

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Compare Image action
1. Connect your Diffchecker account
2. Optional- Select a Input 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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Compare Image on Diffchecker

Description:Compares two images and returns the result.

Version:0.0.1

Key:diffchecker-compare-image

View on GitHub

Diffchecker Overview#

The Diffchecker API allows you to compare differences between texts, images, PDFs, and other files programmatically, providing an automated way to spot changes or inconsistencies. Leveraging this API within Pipedream workflows can automate diff tasks, alerting you to changes, syncing content across platforms, or maintaining consistency in code or document versions. Pipedream's ability to connect to various services and trigger workflows based on numerous events makes it an excellent tool for integrating Diffchecker in a variety of scenarios.

Action Code#

import FormData from "form-data";
import fs from "fs";
import { checkTmp } from "../../common/utils.mjs";
import diffchecker from "../../diffchecker.app.mjs";

export default {
  key: "diffchecker-compare-image",
  name: "Compare Image",
  description: "Compares two images and returns the result.",
  version: "0.0.1",
  type: "action",
  props: {
    diffchecker,
    inputType: {
      type: "string",
      label: "Input Type",
      description: "Specifies the request content-type.",
      options: [
        {
          label: "application/json",
          value: "json",
        },
        {
          label: "multipart/form-data",
          value: "form",
        },
      ],
      reloadProps: true,
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.inputType) {
      let label;
      let description = "Image you want to compare. ";

      switch (this.inputType) {
      case "json" :
        label = "Data URI";
        description += "Provide Data Image URI [Click here for further information](https://en.wikipedia.org/wiki/Data_URI_scheme).";
        break;
      case "form" :
        label = "Path";
        description += "Provide the file path `/tmp/file.png`. [See the documentation](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory).";
        break;
      }

      props.leftImage = {
        type: "string",
        label: `Left Image ${label}`,
        description: `Left ${description}`,
      };
      props.rightImage = {
        type: "string",
        label: `Right Image ${label}`,
        description: `Right ${description}`,
      };
    }
    return props;
  },
  async run({ $ }) {
    let formData = new FormData();
    const leftFilepath = checkTmp(this.leftImage);
    const rightFilepath = checkTmp(this.rightImage);
    const objToSend = {
      inputType: this.inputType,
      outputType: "json",
    };
    switch (this.inputType) {
    case "form" :
      formData.append("left_image", fs.createReadStream(leftFilepath));
      formData.append("right_image", fs.createReadStream(rightFilepath));
      objToSend.data = formData;
      objToSend.headers = formData.getHeaders();
      break;
    case "json" :
      objToSend.data = {
        left_image: this.leftImage.replace(/(\r\n|\n|\r)/gm, ""),
        right_image: this.rightImage.replace(/(\r\n|\n|\r)/gm, ""),
      };
    }
    const response = await this.diffchecker.compareImages(objToSend);
    $.export("$summary", "Successfully compared images");
    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
Diffchecker	`diffchecker`	`app`	This component uses the Diffchecker app.
Input Type	`inputType`	`string`	Select a value from the drop down menu:`{ "label": "application/json", "value": "json" }{ "label": "multipart/form-data", "value": "form" }`