Generate Image from Library Template with Orshot API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Generate Image from Library Template with the Orshot 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 Orshot 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 Generate Image from Library Template action
1. Connect your Orshot account
2. Select a Template ID
3. Select a Response Type
4. Select a Response Format
5. Optional- Configure Template Modifications
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#

Generate Image from Library Template on Orshot

Description:Generate an image from a pre-designed library template using the Orshot API. [See the documentation](https://orshot.com/docs/api-reference/render-from-template)

Version:0.0.2

Key:orshot-generate-image-library-template

View on GitHub

Action Code#

import orshot from "../../orshot.app.mjs";
import {
  getMimeType, parseObject,
} from "../../common/utils.mjs";

export default {
  key: "orshot-generate-image-library-template",
  name: "Generate Image from Library Template",
  description:
    "Generate an image from a pre-designed library template using the Orshot API. [See the documentation](https://orshot.com/docs/api-reference/render-from-template)",
  version: "0.0.2",
  type: "action",
  props: {
    orshot,
    templateId: {
      propDefinition: [
        orshot,
        "templateId",
      ],
    },
    responseType: {
      propDefinition: [
        orshot,
        "responseType",
      ],
    },
    responseFormat: {
      propDefinition: [
        orshot,
        "responseFormat",
      ],
    },
    modifications: {
      propDefinition: [
        orshot,
        "modifications",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      templateId,
      responseType,
      responseFormat,
      modifications = {},
    } = this;

    // Input validation
    if (!templateId) {
      throw new Error("Template ID is required");
    }

    if (!responseType) {
      throw new Error("Response type is required");
    }

    if (!responseFormat) {
      throw new Error("Response format is required");
    }

    // Validate responseType
    const validResponseTypes = [
      "base64",
      "binary",
      "url",
    ];
    if (!validResponseTypes.includes(responseType)) {
      throw new Error(
        `Invalid response type. Must be one of: ${validResponseTypes.join(
          ", ",
        )}`,
      );
    }

    // Validate responseFormat
    const validFormats = [
      "png",
      "jpg",
      "jpeg",
      "webp",
    ];
    if (!validFormats.includes(responseFormat.toLowerCase())) {
      throw new Error(
        `Invalid response format. Must be one of: ${validFormats.join(", ")}`,
      );
    }

    const validModifications = parseObject(modifications);

    try {
      const response = await this.orshot.generateImageFromLibraryTemplate({
        $,
        data: {
          templateId,
          modifications: validModifications,
          response: {
            type: responseType,
            format: responseFormat,
          },
          source: "orshot-pipedream",
        },
      });

      const result = {
        templateId,
        responseType,
        responseFormat,
        modifications: validModifications,
        timestamp: new Date().toISOString(),
      };

      // Handle different response types
      switch (responseType) {
      case "base64":
        result.data = response.data;
        result.mimeType = getMimeType(responseFormat);
        break;
      case "binary":
        result.data = response;
        result.mimeType = getMimeType(responseFormat);
        break;
      case "url":
        result.data = response.data;
        break;
      default:
        result.data = response.data;
      }

      $.export(
        "$summary",
        `Successfully generated image from template ${templateId}`,
      );
      return result;
    } catch (error) {
      const errorMessage = error.message || "Unknown error occurred";
      throw new Error(`Failed to generate image: ${errorMessage}`);
    }
  },
};

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
Orshot	`orshot`	`app`	This component uses the Orshot app.
Template ID	`templateId`	`string`	Select a value from the drop down menu.
Response Type	`responseType`	`string`	Select a value from the drop down menu:`{ "label": "Base64", "value": "base64" }{ "label": "Binary", "value": "binary" }{ "label": "URL", "value": "url" }`
Response Format	`responseFormat`	`string`	Select a value from the drop down menu:`{ "label": "PNG", "value": "png" }{ "label": "JPG", "value": "jpg" }{ "label": "JPEG", "value": "jpeg" }{ "label": "WebP", "value": "webp" }`
Template Modifications	`modifications`	`object`	Key-value pairs for template modifications. The keys should match the modification keys available for your template.