Create Custom Field Options (Context) with Jira API on New Email Matching Search from Gmail API

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

Trigger workflow on

New Email Matching Search from the Gmail API

Next, do this

Create Custom Field Options (Context) with the Jira 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 Jira 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. Connect your Gmail account
2. Configure timer
3. Optional- Configure Search Query
4. Optional- Select one or more Labels
5. Configure Return payload as plaintext
Configure the Create Custom Field Options (Context) action
1. Connect your Jira account
2. Select a Cloud ID
3. Select a Field ID
4. Select a Context ID
5. Configure Options
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.1.1

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.1.1",
  type: "source",
  dedupe: "unique",
  props: {
    gmail,
    ...common.props,
    q: {
      propDefinition: [
        gmail,
        "q",
      ],
    },
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
      optional: true,
    },
    withTextPayload: {
      type: "boolean",
      label: "Return payload as plaintext",
      description: "Convert the payload response into a single text field. **This reduces the size of the payload and makes it easier for LLMs work with.**",
      default: false,
    },
  },
  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
Gmail	`gmail`	`app`	This component uses the Gmail app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
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.
Return payload as plaintext	`withTextPayload`	`boolean`	Convert the payload response into a single text field. This reduces the size of the payload and makes it easier for LLMs work with.

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 Custom Field Options (Context) on Jira

Description:Create a context for custom field options. [See the documentation here](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-post).

Version:0.0.5

Key:jira-create-custom-field-options-context

View on GitHub

Jira Overview#

The Jira API opens up a world of possibilities for automating project management tasks, syncing with other tools, and enhancing data visibility. With Pipedream's integration, you can streamline issue tracking by automatically creating, updating, and searching for issues in Jira, as well as managing projects, sprints, users, and more. This integration not only saves time but also ensures real-time data flow across various platforms, keeping teams in sync and projects on track.

Action Code#

import utils from "../../common/utils.mjs";
import app from "../../jira.app.mjs";

export default {
  key: "jira-create-custom-field-options-context",
  name: "Create Custom Field Options (Context)",
  description: "Create a context for custom field options. [See the documentation here](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-post).",
  version: "0.0.5",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    app,
    cloudId: {
      propDefinition: [
        app,
        "cloudId",
      ],
    },
    fieldId: {
      propDefinition: [
        app,
        "fieldId",
        ({ cloudId }) => ({
          cloudId,
          params: {
            type: [
              "custom",
            ],
          },
        }),
      ],
    },
    contextId: {
      propDefinition: [
        app,
        "contextId",
        ({
          cloudId, fieldId,
        }) => ({
          cloudId,
          fieldId,
        }),
      ],
    },
    options: {
      type: "string[]",
      label: "Options",
      description: "Options to create. Each option should be a JSON object with the following structure as an example: `{ \"value\": \"Manhattan\", \"optionId\": \"1000\", \"disabled\": true }` where the only required field is `value`.",
    },
  },
  methods: {
    createCustomFieldOptionsContext({
      fieldId, contextId, ...args
    }) {
      return this.app._makeRequest({
        method: "POST",
        path: `/field/${fieldId}/context/${contextId}/option`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      createCustomFieldOptionsContext,
      cloudId,
      fieldId,
      contextId,
      options,
    } = this;

    const response = await createCustomFieldOptionsContext({
      $,
      cloudId,
      fieldId,
      contextId,
      data: {
        options: utils.parseArray(options).map(utils.parseOne),
      },
    });

    $.export("$summary", `Successfully created custom field options for field \`${fieldId}\` and context \`${contextId}\``);
    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
Jira	`app`	`app`	This component uses the Jira app.
Cloud ID	`cloudId`	`string`	Select a value from the drop down menu.
Field ID	`fieldId`	`string`	Select a value from the drop down menu.
Context ID	`contextId`	`string`	Select a value from the drop down menu.
Options	`options`	`string[]`	Options to create. Each option should be a JSON object with the following structure as an example: `{ "value": "Manhattan", "optionId": "1000", "disabled": true }` where the only required field is `value`.

Action Authentication#

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

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

read:jira-workmanage:jira-projectread:jira-userwrite:jira-workmanage:jira-data-providerread:meoffline_accessread:issue-details:jiraread:board-scope:jira-softwareread:webhook:jirawrite:webhook:jiraread:field:jiraread:project:jiradelete:webhook:jirawrite:board-scope:jira-softwareread:board-scope.admin:jira-softwareread:sprint:jira-softwarewrite:sprint:jira-softwareread:field.option:jirawrite:field.option:jiraread:custom-field-contextual-configuration:jira write:custom-field-contextual-configuration:jiramanage:jira-configurationread:jql:jira

About Jira#

Jira is the #1 agile project management tool used by teams to plan, track, release, and support great software with confidence

More Ways to Connect Jira + Gmail#

Other Popular Integrations#

Send Email with Gmail API on New Event from Jira API

Jira + Gmail

Create Custom Field Options (Context) with Jira API on New Email Matching Search from Gmail API

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

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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