[Data] Convert JSON to String with Formatting API on New Batch Processed from Imagga API

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

Trigger workflow on

New Batch Processed from the Imagga API

Next, do this

[Data] Convert JSON to String with the Formatting 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 Imagga trigger and Formatting action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Batch Processed trigger
1. Connect your Imagga account
2. Configure Ticket ID
3. Configure timer
Configure the [Data] Convert JSON to String action
1. Connect your Formatting account
2. Configure Input
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 Batch Processed on Imagga

Description:Emit new event when a batch of images has been processed for categorization, tagging, or color extraction.

Version:0.0.1

Key:imagga-new-batch-processed

View on GitHub

Imagga Overview#

The Imagga API is a powerful image recognition tool that enables you to automate the process of analyzing and tagging images. With its AI-driven capabilities, you can extract a wealth of information from visual content. It offers features such as categorization, color extraction, and auto-tagging, making it incredibly useful for building workflows that require image analysis.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import imagga from "../../imagga.app.mjs";

export default {
  key: "imagga-new-batch-processed",
  name: "New Batch Processed",
  description: "Emit new event when a batch of images has been processed for categorization, tagging, or color extraction.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    imagga,
    db: "$.service.db",
    ticketId: {
      propDefinition: [
        imagga,
        "ticketId",
      ],
    },
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  async run() {
    const ticket = await this.imagga.getTicket({
      ticketId: this.ticketId,
    });

    if (ticket.result.is_final) {
      this.$emit(ticket, {
        id: this.ticketId,
        summary: `Batch of the ticket with Id: ${this.ticketId} was processed!`,
        ts: Date.now(),
      });
    }
  },
};

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
Imagga	`imagga`	`app`	This component uses the Imagga app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Ticket ID	`ticketId`	`string`	The ticket ID to track the status of the image processing batch
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Navigate to your dashboard, and copy your API Key and API Secret below.

About Imagga#

Imagga Image Recognition API provides solutions for image tagging & categorization, visual search, content moderation.

Action#

[Data] Convert JSON to String on Formatting

Description:Convert an object to a JSON format string

Version:0.0.5

Key:formatting-convert-json-to-string

View on GitHub

Action Code#

import { defineAction } from "@pipedream/types";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Data] Convert JSON to String",
    description: "Convert an object to a JSON format string",
    key: "formatting-convert-json-to-string",
    version: "0.0.5",
    type: "action",
    props: {
        app,
        input: {
            label: "Input",
            description: "An object to be serialized to a JSON format string.",
            type: "object",
        },
    },
    async run({ $ }) {
        try {
            const result = JSON.stringify(this.input);
            $.export("$summary", "Successfully convert object to JSON string");
            return result;
        }
        catch (err) {
            throw new Error("Error serializing object to JSON string: " + err.toString());
        }
    },
});