Create Collection with Bannerbear API on New Template Created from PublisherKit API

Pipedream makes it easy to connect APIs for Bannerbear, PublisherKit and 2,000+ other apps remarkably fast.

Trigger workflow on

New Template Created from the PublisherKit API

Next, do this

Create Collection with the Bannerbear API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a PublisherKit trigger and Bannerbear action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Template Created trigger
1. Connect your PublisherKit account
2. Configure timer
Configure the Create Collection action
1. Connect your Bannerbear account
2. Select a Template Set UID
3. Configure Modifications
4. Optional- Configure Webhook URL
5. Optional- Configure Metadata
6. Optional- Configure Transparent
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 Template Created on PublisherKit

Description:Emit new event when a new template is created within your PublisherKit account. [See the documentation](https://publisherkit.com/documentation/api)

Version:0.0.1

Key:publisherkit-new-template

View on GitHub

PublisherKit Overview#

The PublisherKit API offers a suite of tools for digital content management, including the ability to manage and distribute various multimedia content like articles, videos, and podcasts. Integrating this API with Pipedream allows you to automate content workflows, sync data across platforms, and react to events in real-time. For instance, you could automatically publish scheduled content, analyze content performance, or update cross-platform content statuses.

Trigger Code#

import publisherkit from "../../publisherkit.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import sampleEmit from "./test-event.mjs";

export default {
  key: "publisherkit-new-template",
  name: "New Template Created",
  description: "Emit new event when a new template is created within your PublisherKit account. [See the documentation](https://publisherkit.com/documentation/api)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    publisherkit,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  hooks: {
    async deploy() {
      await this.processEvent(25);
    },
  },
  methods: {
    _getLastCreated() {
      return this.db.get("lastCreated") || 0;
    },
    _setLastCreated(lastCreated) {
      this.db.set("lastCreated", lastCreated);
    },
    generateMeta(template) {
      return {
        id: template.id,
        summary: `New Template ${template.name}`,
        ts: template.created,
      };
    },
    async processEvent(max) {
      const lastCreated = this._getLastCreated();
      let maxCreated = lastCreated;
      let count = 0;
      const templates = await this.publisherkit.listTemplates();
      for (const template of templates) {
        if (template.created > lastCreated) {
          const meta = this.generateMeta(template);
          this.$emit(template, meta);
          if (template.created > maxCreated) {
            maxCreated = template.created;
          }
          count++;
          if (max && count >= max) {
            break;
          }
        }
      }
      this._setLastCreated(maxCreated);
    },
  },
  async run() {
    await this.processEvent();
  },
  sampleEmit,
};

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
PublisherKit	`publisherkit`	`app`	This component uses the PublisherKit app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About PublisherKit#

PublisherKit helps you to auto-generate News Articles, Social Media Visuals and more.

Action#

Create Collection on Bannerbear

Description:Generates multiple Images based on a Template Set. [See the docs here](https://developers.bannerbear.com/#post-v2-collections).

Version:0.0.1

Key:bannerbear-create-collection

View on GitHub

Bannerbear Overview#

Bannerbear is an automated image and video generation service that allows you to create custom visuals with dynamic data. Using the Bannerbear API, you can programmatically generate images and videos for social media posts, e-commerce product images, personalized email marketing visuals, and more, all tailored to your brand's aesthetic and updated in real time with the latest information.

Action Code#

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

export default {
  key: "bannerbear-create-collection",
  name: "Create Collection",
  description: "Generates multiple Images based on a Template Set. [See the docs here](https://developers.bannerbear.com/#post-v2-collections).",
  type: "action",
  version: "0.0.1",
  props: {
    bannerbear,
    templateSet: {
      propDefinition: [
        bannerbear,
        "templateSetUid",
      ],
    },
    modifications: {
      propDefinition: [
        bannerbear,
        "modifications",
      ],
    },
    webhookUrl: {
      propDefinition: [
        bannerbear,
        "webhookUrl",
      ],
    },
    metadata: {
      propDefinition: [
        bannerbear,
        "metadata",
      ],
    },
    transparent: {
      type: "boolean",
      label: "Transparent",
      description: "Render the collection with a transparent background. Default is `false`.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      templateSet,
      webhookUrl,
      metadata,
      transparent,
    } = this;

    const modifications = utils.parse(this.modifications);

    const response = await this.bannerbear.createCollection({
      $,
      data: {
        template_set: templateSet,
        modifications,
        webhook_url: webhookUrl,
        metadata,
        transparent,
      },
    });

    $.export("$summary", `Successfully created collection with UID ${response.uid}`);

    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
Bannerbear	`bannerbear`	`app`	This component uses the Bannerbear app.
Template Set UID	`templateSet`	`string`	Select a value from the drop down menu.
Modifications	`modifications`	`string`	A list of modifications you want to make. See Create an image for more details on the child parameters. Unlike an Image the modifications list is not always required for a Video, for example: `[{"name": "message", "text": "test message"}]`.
Webhook URL	`webhookUrl`	`string`	A url to POST the full Animated Gif object to upon rendering completed.
Metadata	`metadata`	`string`	Any metadata that you need to store e.g. ID of a record in your DB.
Transparent	`transparent`	`boolean`	Render the collection with a transparent background. Default is `false`.