Create Image with PublisherKit API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create Image with the PublisherKit 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 PublisherKit 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 Create Image action
1. Connect your PublisherKit account
2. Select a Template ID
3. Configure Modifications
4. Configure info
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#

Create Image on PublisherKit

Description:Generates a new image within PublisherKit. [See the documentation](https://publisherkit.com/documentation/api)

Version:0.0.1

Key:publisherkit-create-image

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.

Action Code#

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

export default {
  key: "publisherkit-create-image",
  name: "Create Image",
  description: "Generates a new image within PublisherKit. [See the documentation](https://publisherkit.com/documentation/api)",
  version: "0.0.1",
  type: "action",
  props: {
    publisherkit,
    templateId: {
      propDefinition: [
        publisherkit,
        "templateId",
      ],
    },
    modifications: {
      type: "string[]",
      label: "Modifications",
      description: "Array of objects representing which elements to modify in the template",
    },
    info: {
      type: "alert",
      alertType: "info",
      content: `Additional information regarding **Modifications** can be found in the **[documentation](https://publisherkit.com/documentation/api)**
        \nThe "name" must match the name of the element in the template.
        \n
        \nIf the element is text and you want to change it, it should be added as "text":"new text".
        \n
        \nIf you want to change an image object, it should be "src":"image url".
        \n
        \nExample:
        \`\`\` [
          {
            "name": "headline",
            "text": MY_HEADLINE,
          },
          {
            "name": "feature_image",
            "src": IMAGE_URL,
          }
        ]\`\`\`
        `,
    },
  },
  async run({ $ }) {
    const modifications = this.modifications?.map((modification) => typeof modification === "string"
      ? JSON.parse(modification)
      : modification);
    const response = await this.publisherkit.createImage({
      $,
      data: {
        images: [
          {
            templateID: this.templateId,
            modifications,
          },
        ],
      },
    });
    $.export("$summary", `Successfully created image with ID: ${response.images[0]._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
PublisherKit	`publisherkit`	`app`	This component uses the PublisherKit app.
Template ID	`templateId`	`string`	Select a value from the drop down menu.
Modifications	`modifications`	`string[]`	Array of objects representing which elements to modify in the template