Update Issue with Jira API on New Shipping Label Created from Shipengine API

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

Trigger workflow on

New Shipping Label Created from the Shipengine API

Next, do this

Update Issue with the Jira API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Shipengine 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 Shipping Label Created trigger
1. Connect your Shipengine account
2. Configure Polling schedule
Configure the Update Issue action
1. Connect your Jira account
2. Select a Cloud ID
3. Optional- Configure History Metadata
4. Optional- Configure Properties
5. Optional- Configure Update
6. Optional- Configure Additional properties
7. Select a Issue id or key
8. Optional- Select a Project ID
9. Optional- Select a Issue Type
10. Optional- Configure Notify Users
11. Optional- Configure Override Screen Security
12. Optional- Configure Override Editable Flag
13. Optional- Select a Transition ID
14. Optional- Configure Transition Looped
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 Shipping Label Created on Shipengine

Description:Emit new event when a new label is shipped. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/create_webhook).

Version:0.0.2

Key:shipengine-shipping-label-created

View on GitHub

Shipengine Overview#

The Shipengine API enables robust automation possibilities for shipping logistics. From label creation, rate comparison, to tracking shipments, the API provides the tools to streamline e-commerce and shipping workflows. By harnessing Shipengine's capabilities through Pipedream, you can build seamless integrations that connect your shipping operations with other business processes, enhancing efficiency and reducing manual overhead.

Trigger Code#

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

export default {
  ...common,
  key: "shipengine-shipping-label-created",
  name: "New Shipping Label Created",
  description: "Emit new event when a new label is shipped. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/create_webhook).",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourcesFn() {
      return this.app.listLabels;
    },
    getResourcesFnArgs(url) {
      return {
        url,
        params: {
          created_at_start: this.getLastCreatedAtStart(),
        },
      };
    },
    getResourcesName() {
      return "labels";
    },
    generateMeta(resource) {
      return {
        id: resource.shipment_id,
        ts: Date.parse(resource.created_at),
        summary: `New Shipping Label ${resource.shipment_id}`,
      };
    },
  },
};

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
Shipengine	`app`	`app`	This component uses the Shipengine 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 ShipEngine API

Trigger Authentication#

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

Get your API key in the API Management section

About Shipengine#

Shipping API & multi carrier shipping system

Action#

Update Issue on Jira

Description:Updates an issue. A transition may be applied and issue properties updated as part of the edit, [See the docs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-put)

Version:0.2.10

Key:jira-update-issue

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 common from "../common/issue.mjs";
import constants from "../../common/constants.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...common,
  key: "jira-update-issue",
  name: "Update Issue",
  description: "Updates an issue. A transition may be applied and issue properties updated as part of the edit, [See the docs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-put)",
  version: "0.2.10",
  type: "action",
  props: {
    ...common.props,
    issueIdOrKey: {
      reloadProps: true,
      propDefinition: [
        common.props.app,
        "issueIdOrKey",
        ({ cloudId }) => ({
          cloudId,
        }),
      ],
    },
    projectId: {
      propDefinition: [
        common.props.app,
        "projectID",
        ({ cloudId }) => ({
          cloudId,
        }),
      ],
      optional: true,
    },
    issueTypeId: {
      reloadProps: true,
      propDefinition: [
        common.props.app,
        "issueType",
        ({
          cloudId, projectId,
        }) => ({
          cloudId,
          projectId,
        }),
      ],
      optional: true,
    },
    notifyUsers: {
      type: "boolean",
      label: "Notify Users",
      description: "Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.",
      optional: true,
    },
    overrideScreenSecurity: {
      type: "boolean",
      label: "Override Screen Security",
      description: "Whether screen security should be overridden to enable hidden fields to be edited. Available to Connect app users with admin permissions.",
      optional: true,
    },
    overrideEditableFlag: {
      type: "boolean",
      label: "Override Editable Flag",
      description: "Whether screen security should be overridden to enable uneditable fields to be edited. Available to Connect app users with admin permissions.",
      optional: true,
    },
    transitionId: {
      label: "Transition ID",
      description: "The ID of the issue transition. Retrieving options requires a static `issueIdOrKey`. Required when specifying a transition to undertake.",
      propDefinition: [
        common.props.app,
        "transition",
        ({
          cloudId, issueIdOrKey,
        }) => ({
          cloudId,
          issueIdOrKey,
        }),
      ],
    },
    transitionLooped: {
      type: "boolean",
      label: "Transition Looped",
      description: "Whether the transition is looped.",
      optional: true,
    },
  },
  async additionalProps() {
    const {
      cloudId,
      projectId,
      issueTypeId,
      issueIdOrKey,
    } = this;

    try {
      const { fields } = await this.app.getEditIssueMetadata({
        cloudId,
        issueIdOrKey,
      });

      return this.getDynamicFields({
        fields,
      });
    } catch {
      if (!issueTypeId) {
        throw new ConfigurationError("Please enter `projectId` and `IssueTypeId` to retrieve additional props.");
      }
      const {
        projects: [
          {
            issuetypes: [
              { fields = {} } = {},
            ],
          },
        ],
      } = await this.app.getCreateIssueMetadata({
        cloudId,
        params: {
          projectIds: projectId,
          issuetypeIds: issueTypeId,
          expand: "projects.issuetypes.fields",
        },
      });

      const keys = [
        constants.FIELD_KEY.ISSUETYPE,
        constants.FIELD_KEY.PROJECT,
      ];

      return this.getDynamicFields({
        fields,
        predicate: ({ key }) => !keys.includes(key),
      });
    }
  },
  async run({ $ }) {
    const {
      app,
      cloudId,
      issueIdOrKey,
      // eslint-disable-next-line no-unused-vars
      projectId,
      // eslint-disable-next-line no-unused-vars
      issueTypeId,
      notifyUsers,
      overrideScreenSecurity,
      overrideEditableFlag,
      historyMetadata,
      properties,
      transitionId,
      transitionLooped,
      update,
      additionalProperties,
      ...dynamicFields
    } = this;

    const fields = utils.reduceProperties({
      additionalProps: this.formatFields(dynamicFields),
    });

    const { transition } = utils.reduceProperties({
      additionalProps: {
        transition: [
          transitionId,
          {
            id: transitionId,
            looped: transitionLooped,
          },
        ],
      },
    });

    const params = utils.reduceProperties({
      additionalProps: {
        notifyUsers,
        overrideScreenSecurity,
        overrideEditableFlag,
      },
    });

    await app.updateIssue({
      $,
      cloudId,
      issueIdOrKey,
      params,
      data: {
        fields,
        historyMetadata: utils.parseObject(historyMetadata),
        properties: utils.parse(properties),
        update: utils.parseObject(update),
        ...utils.parseObject(additionalProperties),
      },
      transition,
    });

    $.export("$summary", `Issue with ID(or key): ${this.issueIdOrKey} has been updated.`);

    return {
      success: true,
      issueIdOrKey,
    };
  },
};

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.
History Metadata	`historyMetadata`	`object`	Additional issue history details.
Properties	`properties`	`string`	Details of issue properties to be add or update, please provide an array of objects with keys and values.
Update	`update`	`object`	A Map containing the field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`.
Additional properties	`additionalProperties`	`object`	Extra properties of any type may be provided to this object.
Issue id or key	`issueIdOrKey`	`string`	Select a value from the drop down menu.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
Issue Type	`issueTypeId`	`string`	Select a value from the drop down menu.
Notify Users	`notifyUsers`	`boolean`	Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.
Override Screen Security	`overrideScreenSecurity`	`boolean`	Whether screen security should be overridden to enable hidden fields to be edited. Available to Connect app users with admin permissions.
Override Editable Flag	`overrideEditableFlag`	`boolean`	Whether screen security should be overridden to enable uneditable fields to be edited. Available to Connect app users with admin permissions.
Transition ID	`transitionId`	`string`	Select a value from the drop down menu.
Transition Looped	`transitionLooped`	`boolean`	Whether the transition is looped.

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-projectmanage:jira-configurationread:jira-userwrite:jira-workmanage:jira-data-providerread:meoffline_accessread:issue-details:jiraread:board-scope:jira-softwarewrite:webhook:jiraread:field:jiraread:project:jiradelete:webhook:jirawrite:board-scope:jira-softwareread:board-scope.admin:jira-softwareread:sprint:jira-softwarewrite:sprint:jira-software

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

Other Popular Integrations#

Find Tracking Status with Shipengine API on New Event from Jira API

Jira + Shipengine

Update Issue with Jira API on New Shipping Label Created from Shipengine API

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

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

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