Create Image with PublisherKit API on New Email Matching Search from Gmail API

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

Trigger workflow on

New Email Matching Search from the Gmail 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 Gmail 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 New Email Matching Search trigger
1. Configure timer
2. Connect your Gmail account
3. Optional- Configure Search Query
4. Optional- Select one or more Labels
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#

New Email Matching Search on Gmail

Description:Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.

Version:0.0.4

Key:gmail-new-email-matching-search

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-messages.mjs";

export default {
  ...common,
  key: "gmail-new-email-matching-search",
  name: "New Email Matching Search",
  description: "Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    gmail,
    q: {
      propDefinition: [
        gmail,
        "q",
      ],
    },
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getLabels() {
      return this.labels;
    },
    generateMeta(message) {
      const selectedHeader = message.payload.headers.find(({ name }) => name === "Subject");
      const subject = selectedHeader?.value || "No subject";
      return {
        id: message.id,
        summary: `New email: ${subject}`,
        ts: +message.internalDate,
      };
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Gmail	`gmail`	`app`	This component uses the Gmail app.
Search Query	`q`	`string`	Apply a search filter using Gmail's standard search operators
Labels	`labels`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

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

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

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

Action 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.

More Ways to Connect PublisherKit + Gmail#

Other Popular Integrations#

Create Image with PublisherKit API on New Labeled Email from Gmail API

Gmail + PublisherKit

Create Image with PublisherKit API on New Email Matching Search from Gmail API

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

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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