Generate Image with Abyssale API on New Field in Document from MongoDB API

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

Trigger workflow on

New Field in Document from the MongoDB API

Next, do this

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

Select this integration
Configure the New Field in Document trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
4. Select a Collection
5. Select a Document
Configure the Generate Image action
1. Connect your Abyssale account
2. Select a Template ID
3. Select a Template Format Name
4. Configure Elements
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 Field in Document on MongoDB

Description:Emit new an event when a new field is added to a document

Version:0.0.7

Key:mongodb-new-field-in-document

View on GitHub

MongoDB Overview#

The MongoDB API provides powerful capabilities to interact with a MongoDB database, allowing you to perform CRUD (Create, Read, Update, Delete) operations, manage databases, and execute sophisticated queries. With Pipedream, you can harness these abilities to automate tasks, sync data across various apps, and react to events in real-time. It’s a combo that’s particularly potent for managing data workflows, syncing application states, or triggering actions based on changes to your data.

Trigger Code#

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

export default {
  ...common,
  key: "mongodb-new-field-in-document",
  name: "New Field in Document",
  description: "Emit new an event when a new field is added to a document",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        common.props.mongodb,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    document: {
      propDefinition: [
        common.props.mongodb,
        "document",
        (c) => ({
          database: c.database,
          collection: c.collection,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getFields() {
      return this.db.get("fields");
    },
    _setFields(fields) {
      this.db.set("fields", fields);
    },
    isRelevant(key, fields) {
      return !fields.includes(key);
    },
    async processEvent(client, ts) {
      const fields = this._getFields() || [];
      const collection = this.mongodb.getCollection(client, this.database, this.collection);
      const documents = await this.mongodb.listDocuments(collection);
      const doc = documents.find((obj) => {
        return obj._id == this.document;
      });
      const keys = Object.keys(doc);
      for (const key of keys) {
        if (!this.isRelevant(key, fields)) {
          continue;
        }
        fields.push(key);
        this.emitEvent(key, ts);
      }
      this._setFields(fields);
    },
    generateMeta(key, ts) {
      return {
        id: key,
        summary: `New Field ${key}`,
        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
MongoDB	`mongodb`	`app`	This component uses the MongoDB app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Database	`database`	`string`	Select a value from the drop down menu.
Collection	`collection`	`string`	Select a value from the drop down menu.
Document	`document`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Before you connect to your Mongo database from Pipedream, please make sure your database is accessible from the public internet. You may need to add a firewall rule allowing connections from 0.0.0.0/0.

Then, enter the details of your Mongo host / database below.

About MongoDB#

MongoDB is an open source NoSQL database management program.

Action#

Generate Image on Abyssale

Description:Generates a single image from a template. [See the documentation](https://api-reference.abyssale.com/#tag/Images/paths/~1banner-builder~1%7BtemplateId%7D~1generate/post)

Version:0.0.1

Key:abyssale-generate-image

View on GitHub

Abyssale Overview#

The Abyssale API enables automatic generation of banners and images tailored for various digital platforms. Through Pipedream, you can harness this capability within your workflows, dynamically producing visuals for marketing campaigns, social media, or personalized user content. Integrating Abyssale with Pipedream allows for the automation of image creation based on triggers or schedules, data enrichment from different sources, and connecting with various apps to streamline digital asset management and deployment.

Action Code#

import abyssale from "../../abyssale.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "abyssale-generate-image",
  name: "Generate Image",
  description: "Generates a single image from a template. [See the documentation](https://api-reference.abyssale.com/#tag/Images/paths/~1banner-builder~1%7BtemplateId%7D~1generate/post)",
  version: "0.0.1",
  type: "action",
  props: {
    abyssale,
    templateId: {
      propDefinition: [
        abyssale,
        "templateId",
      ],
    },
    templateFormatName: {
      propDefinition: [
        abyssale,
        "templateFormatName",
        (c) => ({
          templateId: c.templateId,
        }),
      ],
    },
    elements: {
      propDefinition: [
        abyssale,
        "elements",
      ],
    },
  },
  methods: {
    generateImage({
      templateId, ...args
    }) {
      return this.abyssale.post({
        path: `/banner-builder/${templateId}/generate`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      generateImage,
      templateId,
      templateFormatName,
      elements,
    } = this;

    const response = await generateImage({
      templateId,
      data: {
        template_format_name: templateFormatName,
        elements: utils.parseElements(elements),
      },
    });

    $.export("$summary", `Successfully generated image with ID: \`${response.id}\``);

    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
Abyssale	`abyssale`	`app`	This component uses the Abyssale app.
Template ID	`templateId`	`string`	Select a value from the drop down menu.
Template Format Name	`templateFormatName`	`string`	Select a value from the drop down menu.
Elements	`elements`	`object`	A dictionary containing all elements with properties you would like to override form the default template. Keys correspond to element names in the layer eg. `bg_image` and `title`. Values correspond to the properties you would like to override eg. For `title` key the value could be `{ "payload": "Hello World" }`. See the documentation

Action Authentication#

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

To retrieve your API keys,