Search Issues with JQL with Jira API on Status Changed from FTrack API

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

Trigger workflow on

Status Changed from the FTrack 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 FTrack 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 Status Changed trigger
1. Connect your FTrack account
2. Configure Polling schedule
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#

Status Changed on FTrack

Description:Triggered when the status of an item is changed. [See the documentation](https://help.ftrack.com/en/articles/1040498-operations#query)

Version:0.0.1

Key:ftrack-status-changed

View on GitHub

FTrack Overview#

The FTrack API is a powerhouse for creative project management, enabling users to automate and integrate a wide array of tasks related to project tracking, asset management, and team collaboration. With Pipedream, you can harness this API to create custom workflows that trigger actions within FTrack or connect it with other apps to streamline your creative operations. It's a toolset for improving efficiency by automating repetitive tasks, syncing data across applications, and orchestrating complex project management activities.

Trigger Code#

import common from "../common/polling.mjs";

export default {
  ...common,
  key: "ftrack-status-changed",
  name: "Status Changed",
  description: "Triggered when the status of an item is changed. [See the documentation](https://help.ftrack.com/en/articles/1040498-operations#query)",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceFn() {
      return this.app.listStatusChanges;
    },
    getResourceFnArgs() {
      return;
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `Status Changed: ${resource.id}`,
        ts: Date.now(),
      };
    },
  },
};

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
FTrack	`app`	`app`	This component uses the FTrack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling schedule	`timer`	`$.interface.timer`	How often to poll the API

Trigger Authentication#

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

To connect FTrack, you will need an FTrack Studio account.

To retrieve your Username and API Key,

Navigate to your ftrack account and sign in
Click the dropdown on the top right

For Username:

Go to “My Account” > “Account”

There are two types of API Keys, Personal and Global.

For Personal API Key:

Go to “My Account” > “Security Settings”

For Global API Key:

Go to “System Settings” > “Security” > “API Keys”

Your subdomain is 1234 if your ftrack URL is https://1234.ftrackapp.com

About FTrack#

ftrack, a Backlight business, is the creator of Emmy and Academy Award-winning team collaboration and media review platforms for the creative industries.

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

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.0.2",
  type: "action",
  props: {
    jira,
    cloudId: {
      propDefinition: [
        jira,
        "cloudId",
      ],
    },
    jql: {
      type: "string",
      label: "JQL Query",
      description: "The [JQL](https://support.atlassian.com/jira-software-cloud/docs/what-is-advanced-search-in-jira-cloud/) query to search for issues",
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "Maximum number of issues to return (default: 50, max: 100)",
      optional: true,
      default: 50,
      min: 1,
      max: 100,
    },
    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: {
    searchIssues(args = {}) {
      return this.jira._makeRequest({
        path: "/search/jql",
        ...args,
      });
    },
  },
  async run({ $ }) {
    try {
      const response = await this.searchIssues({
        $,
        cloudId: this.cloudId,
        params: {
          jql: this.jql,
          maxResults: this.maxResults,
          fields: this.fields,
          expand: this.expand
            ? this.expand.join(",")
            : undefined,
          properties: this.properties,
          fieldsByKeys: this.fieldsByKeys,
          failFast: this.failFast,
        },
      });
      $.export("$summary", `Successfully retrieved ${response.issues.length} issues`);
      return response;
    } 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
Max Results	`maxResults`	`integer`	Maximum number of issues to return (default: 50, max: 100)
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

Search Issues with JQL with Jira API on Status Changed from FTrack API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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