Create Run with Terraform API on New Email Matching Search from Gmail API

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

Trigger workflow on

New Email Matching Search from the Gmail API

Next, do this

Create Run with the Terraform 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 Terraform 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 Run action
1. Connect your Terraform account
2. Select a Organization
3. Select a Workspace
4. Select a Configuration Version
5. Optional- Configure Message
6. Configure Allow Empty Apply
7. Optional- Configure Allow Config Generation
8. Optional- Configure Auto Apply
9. Optional- Configure Is Destroy
10. Optional- Configure Refresh
11. Optional- Configure Refresh Only
12. Optional- Configure Plan Only
13. Optional- Configure Save Plan
14. Optional- Configure Terraform Version
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 Run on Terraform

Description:Creates a new run in Terraform. [See the documentation](https://developer.hashicorp.com/terraform/cloud-docs/api-docs/run#create-a-run)

Version:0.0.1

Key:terraform-create-run

View on GitHub

Terraform Overview#

The Terraform API allows for the automation of infrastructure as code (IaC) management tasks. With Pipedream, you can orchestrate workflows that interact with Terraform to create, update, or destroy infrastructure programmatically. You can trigger workflows with webhooks, schedule them, or run them in response to events from other services. By integrating Terraform with Pipedream, you can streamline your DevOps processes, enforce compliance, and manage infrastructure changes with ease.

Action Code#

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

export default {
  key: "terraform-create-run",
  name: "Create Run",
  description: "Creates a new run in Terraform. [See the documentation](https://developer.hashicorp.com/terraform/cloud-docs/api-docs/run#create-a-run)",
  version: "0.0.1",
  type: "action",
  props: {
    terraform,
    orgId: {
      propDefinition: [
        terraform,
        "orgId",
      ],
    },
    workspaceId: {
      propDefinition: [
        terraform,
        "workspaceId",
        (c) => ({
          orgId: c.orgId,
        }),
      ],
    },
    configurationVersion: {
      propDefinition: [
        terraform,
        "configurationVersion",
        (c) => ({
          workspaceId: c.workspaceId,
        }),
      ],
    },
    message: {
      type: "string",
      label: "Message",
      description: "Specifies the message associated with this run.",
      optional: true,
    },
    allowEmptyApply: {
      type: "boolean",
      label: "Allow Empty Apply",
      description: "Specifies whether Terraform can apply the run even when the plan [contains no changes](https://developer.hashicorp.com/terraform/cloud-docs/run/modes-and-options#allow-empty-apply). Often used to [upgrade state](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/state#upgrading-state) after upgrading a workspace to a new terraform version.",
    },
    allowConfigGeneration: {
      type: "boolean",
      label: "Allow Config Generation",
      description: "Specifies whether Terraform can [generate resource configuration](https://developer.hashicorp.com/terraform/language/import/generating-configuration) when planning to import new resources. If false, import blocks without a corresponding resource block will error.",
      optional: true,
    },
    autoApply: {
      type: "boolean",
      label: "Auto Apply",
      description: "Whether to automatically apply changes when a Terraform plan is successful. Defaults to the [Auto Apply](https://developer.hashicorp.com/terraform/cloud-docs/workspaces/settings#auto-apply-and-manual-apply) workspace setting.",
      optional: true,
    },
    isDestroy: {
      type: "boolean",
      label: "Is Destroy",
      description: "Specifies whether this plan is a destroy plan that will destroy all provisioned resources. Mutually exclusive with `refresh-only`.",
      optional: true,
    },
    refresh: {
      type: "boolean",
      label: "Refresh",
      description: "Specifies whether or not to refresh the state before a plan.",
      optional: true,
    },
    refreshOnly: {
      type: "boolean",
      label: "Refresh Only",
      description: "Whether this run should refresh the state without modifying any resources. Mutually exclusive with `is-destroy`.",
      optional: true,
    },
    planOnly: {
      type: "boolean",
      label: "Plan Only",
      description: "Specifies if this is a [speculative, plan-only](https://developer.hashicorp.com/terraform/cloud-docs/run/modes-and-options#plan-only-speculative-plan) run that Terraform cannot apply. Often used in conjunction with terraform-version in order to test whether an upgrade would succeed.",
      optional: true,
    },
    savePlan: {
      type: "boolean",
      label: "Save Plan",
      description: "Specifies if this should be a saved plan run. Terraform can apply saved plan runs, but they perform their plan and checks without becoming the workspace's current run (like a plan-only run), and will only become the current run if you confirm them for apply. When creating new [configuration versions](https://developer.hashicorp.com/terraform/cloud-docs/api-docs/configuration-versions) for saved plan runs, be sure to make them `provisional`",
      optional: true,
    },
    terraformVersion: {
      type: "string",
      label: "Terraform Version",
      description: "Specifies the Terraform version to use in this run. Only valid for plan-only runs; must be a valid Terraform version available to the organization.",
      optional: true,
    },
  },
  async run({ $ }) {
    const { data } = await this.terraform.createRun({
      data: {
        data: {
          attributes: {
            "message": this.message,
            "allow-empty-apply": this.allowEmptyApply,
            "allow-config-generation": this.allowConfigGeneration,
            "auto-apply": this.autoApply,
            "is-destroy": this.isDestroy,
            "refresh": this.refresh,
            "refresh-only": this.refreshOnly,
            "plan-only": this.planOnly,
            "save-plan": this.savePlan,
            "terraform-version": this.terraformVersion,
          },
          relationships: {
            workspace: {
              data: {
                id: this.workspaceId,
              },
            },
            configurationVersion: this.configurationVersion
              ? {
                data: {
                  id: this.configurationVersion,
                },
              }
              : undefined,
          },
        },
      },
      $,
    });

    if (data) {
      $.export("$summary", `Successfully created run with ID ${data.id}.`);
    }

    return data;
  },
};

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
Terraform	`terraform`	`app`	This component uses the Terraform app.
Organization	`orgId`	`string`	Select a value from the drop down menu.
Workspace	`workspaceId`	`string`	Select a value from the drop down menu.
Configuration Version	`configurationVersion`	`string`	Select a value from the drop down menu.
Message	`message`	`string`	Specifies the message associated with this run.
Allow Empty Apply	`allowEmptyApply`	`boolean`	Specifies whether Terraform can apply the run even when the plan contains no changes. Often used to upgrade state after upgrading a workspace to a new terraform version.
Allow Config Generation	`allowConfigGeneration`	`boolean`	Specifies whether Terraform can generate resource configuration when planning to import new resources. If false, import blocks without a corresponding resource block will error.
Auto Apply	`autoApply`	`boolean`	Whether to automatically apply changes when a Terraform plan is successful. Defaults to the Auto Apply workspace setting.
Is Destroy	`isDestroy`	`boolean`	Specifies whether this plan is a destroy plan that will destroy all provisioned resources. Mutually exclusive with `refresh-only`.
Refresh	`refresh`	`boolean`	Specifies whether or not to refresh the state before a plan.
Refresh Only	`refreshOnly`	`boolean`	Whether this run should refresh the state without modifying any resources. Mutually exclusive with `is-destroy`.
Plan Only	`planOnly`	`boolean`	Specifies if this is a speculative, plan-only run that Terraform cannot apply. Often used in conjunction with terraform-version in order to test whether an upgrade would succeed.
Save Plan	`savePlan`	`boolean`	Specifies if this should be a saved plan run. Terraform can apply saved plan runs, but they perform their plan and checks without becoming the workspace's current run (like a plan-only run), and will only become the current run if you confirm them for apply. When creating new configuration versions for saved plan runs, be sure to make them `provisional`
Terraform Version	`terraformVersion`	`string`	Specifies the Terraform version to use in this run. Only valid for plan-only runs; must be a valid Terraform version available to the organization.

Action Authentication#

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

About Terraform#

Terraform Cloud enables infrastructure automation for provisioning, compliance, and management of any cloud, datacenter, and service.

More Ways to Connect Terraform + Gmail#

Other Popular Integrations#

Create Run with Terraform API on New Labeled Email from Gmail API

Gmail + Terraform

Create Run with Terraform API on New Email Matching Search from Gmail API

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