Generate Image from Library Template with Orshot API on New Worksheet (Instant) from Google Sheets API

Pipedream makes it easy to connect APIs for Orshot, Google Sheets and 2,700+ other apps remarkably fast.

Trigger workflow on

New Worksheet (Instant) from the Google Sheets 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 Google Sheets 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 New Worksheet (Instant) trigger
1. Connect your Google Sheets account
2. Configure Push notification renewal schedule
3. Optional- Select a Drive
4. Select a Spreadsheet ID
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#

New Worksheet (Instant) on Google Sheets

Description:Emit new event each time a new worksheet is created in a spreadsheet.

Version:0.1.13

Key:google_sheets-new-worksheet

View on GitHub

Google Sheets Overview#

The Google Sheets API allows for the creation, reading, updating, and deletion of data within Google Sheets, enabling a robust platform for spreadsheet management and data manipulation. Through Pipedream, you can craft serverless workflows that respond to various triggers, such as webhook events, emails, or scheduled times, to interact with Google Sheets. This synergy can automate reporting, synchronize data across applications, manage inventory, track leads in a CRM, or even conduct survey analysis by updating and retrieving sheet data on the fly.

Trigger Code#

import httpBase from "../common/http-based/sheet.mjs";
import newWorksheet from "../common/new-worksheet.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...httpBase,
  ...newWorksheet,
  key: "google_sheets-new-worksheet",
  type: "source",
  name: "New Worksheet (Instant)",
  description: "Emit new event each time a new worksheet is created in a spreadsheet.",
  version: "0.1.13",
  dedupe: "unique",
  hooks: {
    ...httpBase.hooks,
    ...newWorksheet.hooks,
  },
  props: {
    ...httpBase.props,
    ...newWorksheet.props,
  },
  methods: {
    ...httpBase.methods,
    ...newWorksheet.methods,
  },
  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
Google Sheets	`googleSheets`	`app`	This component uses the Google Sheets app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Push notification renewal schedule	`timer`	`$.interface.timer`	The Google Drive API requires occasionally renewal of push notification subscriptions. This runs in the background, so you should not need to modify this schedule.
Drive	`watchedDrive`	`string`	Select a value from the drop down menu.
Spreadsheet ID	`sheetID`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Google Sheets uses OAuth authentication. When you connect your Google Sheets account, Pipedream will open a popup window where you can sign into Google Sheets and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Sheets API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/drive

About Google Sheets#

Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.

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.

Action Authentication#

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

About Orshot#

Automated Image Generation for Marketing

More Ways to Connect Orshot + Google Sheets#

Other Popular Integrations#

Generate Image from Library Template with Orshot API on New Comment (Instant) from Google Sheets API

Google Sheets + Orshot

Generate Image from Library Template with Orshot API on New Worksheet (Instant) from Google Sheets API

Pipedream makes it easy to connect APIs for Orshot, Google Sheets and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular