Execute Homekit Scene with Pushcut API on New Email Matching Search from Gmail API

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

Trigger workflow on

New Email Matching Search from the Gmail API

Next, do this

Execute Homekit Scene with the Pushcut 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 Pushcut 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 Execute Homekit Scene action
1. Connect your Pushcut account
2. Select a Homekit Scene
3. Optional- Configure Timeout
4. Optional- Configure Delay
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#

Execute Homekit Scene on Pushcut

Description:Schedules an Automation Server action request for a homekit scene. [See the documentation](https://www.pushcut.io/webapi)

Version:0.0.1

Key:pushcut-execute-homekit-scene

View on GitHub

Pushcut Overview#

The Pushcut API enables the automation of iOS notifications with custom actions, triggering events based on various conditions. On Pipedream, you can harness this functionality to create intricate workflows, combining Pushcut notifications with a multitude of services to act based on data from APIs, schedules, or other apps. Think of Pushcut as a bridge between the real world and your digital tasks, letting you know when to act and offering shortcuts to execute specific automations directly from your iOS devices.

Action Code#

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

export default {
  key: "pushcut-execute-homekit-scene",
  name: "Execute Homekit Scene",
  description: "Schedules an Automation Server action request for a homekit scene. [See the documentation](https://www.pushcut.io/webapi)",
  version: "0.0.1",
  type: "action",
  props: {
    pushcut,
    homekit: {
      propDefinition: [
        pushcut,
        "homekitScene",
      ],
    },
    timeout: {
      propDefinition: [
        pushcut,
        "timeout",
      ],
    },
    delay: {
      propDefinition: [
        pushcut,
        "delay",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.pushcut.executeAction({
      data: {
        homekit: this.homekit,
        timeout: this.timeout,
        delay: this.delay,
      },
      $,
    });

    $.export("$summary", `Successfully executed homekit ${this.homekit}.`);

    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
Pushcut	`pushcut`	`app`	This component uses the Pushcut app.
Homekit Scene	`homekit`	`string`	Select a value from the drop down menu.
Timeout	`timeout`	`string`	Timeout in seconds, or 'nowait'
Delay	`delay`	`string`	Duration in which this request should be executed. Eg: 10s, 15m, 6h

Action Authentication#

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

To generate your API Key,

Navigate to your Pushcut account and sign in
Go to “Account”
Click the “Add API Key” button

About Pushcut#

Automate Smart Home Workflow

More Ways to Connect Pushcut + Gmail#

Other Popular Integrations#

Execute Homekit Scene with Pushcut API on New Labeled Email from Gmail API

Gmail + Pushcut

Execute Homekit Scene with Pushcut API on New Email Matching Search from Gmail API

Pipedream makes it easy to connect APIs for Pushcut, 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