Search Issues with JQL with Jira API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Jira, Pipedream and 3,000+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Search Issues with JQL 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 Pipedream 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 Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Search Issues with JQL action
1. Connect your Jira account
2. Select a Cloud ID
3. Configure JQL Query
4. Optional- Configure Max Results
5. Optional- Configure Fields
6. Optional- Select one or more Expand
7. Optional- Configure Properties
8. Optional- Configure Fields by Keys
9. Optional- Configure Fail Fast
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.2

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.2",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Search Issues with JQL on Jira

Description:Search for issues using JQL (Jira Query Language). [See the documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-jql-get)

Version:0.1.3

Key:jira-search-issues-with-jql

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 jira from "../../jira.app.mjs";

export default {
  name: "Search Issues with JQL",
  description: "Search for issues using JQL (Jira Query Language). [See the documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-jql-get)",
  key: "jira-search-issues-with-jql",
  version: "0.1.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    jira,
    cloudId: {
      propDefinition: [
        jira,
        "cloudId",
      ],
    },
    jql: {
      type: "string",
      label: "JQL Query",
      description: "The JQL query to search for issues. [See the documentation for syntax and examples](https://support.atlassian.com/jira-software-cloud/docs/what-is-advanced-search-in-jira-cloud/)",
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "Maximum number of issues to return (default: 50)",
      optional: true,
      default: 50,
      min: 1,
      max: 5000,
    },
    fields: {
      type: "string",
      label: "Fields",
      description: "Comma-separated list of fields to return for each issue",
      default: "*all",
      optional: true,
    },
    expand: {
      type: "string[]",
      label: "Expand",
      description: "Use expand to include additional information about the issues in the response",
      optional: true,
      options: [
        {
          label: "Returns field values rendered in HTML format",
          value: "renderedFields",
        },
        {
          label: "Returns the display name of each field",
          value: "names",
        },
        {
          label: "Returns the schema describing a field type",
          value: "schema",
        },
        {
          label: "Returns all possible transitions for the issue",
          value: "transitions",
        },
        {
          label: "Returns information about how each field can be edited",
          value: "editmeta",
        },
        {
          label: "Returns a list of recent updates to an issue, sorted by date, starting from the most recent",
          value: "changelog",
        },
        {
          label: "Returns a JSON array for each version of a field's value, with the highest number representing the most recent version",
          value: "versionedRepresentations",
        },
      ],
    },
    properties: {
      type: "string",
      label: "Properties",
      description: "A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.",
      optional: true,
    },
    fieldsByKeys: {
      type: "boolean",
      label: "Fields by Keys",
      description: "Reference fields by their key (rather than ID). The default is `false`.",
      optional: true,
    },
    failFast: {
      type: "boolean",
      label: "Fail Fast",
      description: "Fail this request early if we can't retrieve all field data",
      optional: true,
    },
  },
  methods: {
    getMaxResultsPerPage() {
      return Math.min(this.maxResults, 1000);
    },
    async paginate({
      params, maxResults, ...otherArgs
    }) {
      const results = [];
      let nextPageToken;
      let response;

      do {
        response = await this.jira.searchIssues({
          ...otherArgs,
          params: {
            ...params,
            ...(nextPageToken && {
              nextPageToken,
            }),
          },
        });

        const pageResults = response.issues;
        const pageLength = pageResults?.length;
        if (!pageLength) {
          break;
        }

        // If maxResults is specified, only add what we need
        if (maxResults && results.length + pageLength > maxResults) {
          const remainingSlots = maxResults - results.length;
          results.push(...pageResults.slice(0, remainingSlots));
          break;
        } else {
          results.push(...pageResults);
        }

        // Also break if we've reached maxResults exactly
        if (maxResults && results.length >= maxResults) {
          break;
        }

        nextPageToken = response.nextPageToken;
      } while (nextPageToken && !response.isLast);

      return results;
    },
  },
  async run({ $ }) {
    try {
      const issues = await this.paginate({
        $,
        cloudId: this.cloudId,
        params: {
          jql: this.jql,
          maxResults: this.getMaxResultsPerPage(),
          fields: this.fields,
          expand: this.expand
            ? this.expand.join(",")
            : undefined,
          properties: this.properties,
          fieldsByKeys: this.fieldsByKeys,
          failFast: this.failFast,
        },
        maxResults: this.maxResults,
      });
      $.export("$summary", `Successfully retrieved ${issues.length} issues`);
      return {
        issues,
      };
    } catch (error) {
      throw new Error(`Failed to search issues: ${error.message}`);
    }
  },
};

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	`jira`	`app`	This component uses the Jira app.
Cloud ID	`cloudId`	`string`	Select a value from the drop down menu.
JQL Query	`jql`	`string`	The JQL query to search for issues. See the documentation for syntax and examples
Max Results	`maxResults`	`integer`	Maximum number of issues to return (default: 50)
Fields	`fields`	`string`	Comma-separated list of fields to return for each issue
Expand	`expand`	`string[]`	Select a value from the drop down menu:`{ "label": "Returns field values rendered in HTML format", "value": "renderedFields" }{ "label": "Returns the display name of each field", "value": "names" }{ "label": "Returns the schema describing a field type", "value": "schema" }{ "label": "Returns all possible transitions for the issue", "value": "transitions" }{ "label": "Returns information about how each field can be edited", "value": "editmeta" }{ "label": "Returns a list of recent updates to an issue, sorted by date, starting from the most recent", "value": "changelog" }{ "label": "Returns a JSON array for each version of a field's value, with the highest number representing the most recent version", "value": "versionedRepresentations" }`
Properties	`properties`	`string`	A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.
Fields by Keys	`fieldsByKeys`	`boolean`	Reference fields by their key (rather than ID). The default is `false`.
Fail Fast	`failFast`	`boolean`	Fail this request early if we can't retrieve all field data

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 + Pipedream#

Other Popular Integrations#

JIRA - Create Issue with Jira API on New Scheduled Tasks (Alpha) from Pipedream API

Pipedream + Jira

Search Issues with JQL with Jira API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Jira, Pipedream and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular