Search Labels with Shipengine API on New Issue Created Event (Instant) from Jira API

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

Trigger workflow on

New Issue Created Event (Instant) from the Jira API

Next, do this

Search Labels with the Shipengine 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 Jira trigger and Shipengine action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Issue Created Event (Instant) trigger
1. Connect your Jira account
2. Select a Cloud ID
3. Configure JQL Filter
4. Optional- Configure Override Existing Webhooks
Configure the Search Labels action
1. Connect your Shipengine account
2. Select a Label Status
3. Select a Carrier ID
4. Select a Service Code
5. Select a Tracking Number
6. Select a Shipment ID
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 Issue Created Event (Instant) on Jira

Description:Emit new event when an issue is created. Note that Jira supports only one webhook, if more sources are needed please use `New Event` source and select multiple events.

Version:0.0.14

Key:jira-issue-created

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.

Trigger Code#

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

export default {
  key: "jira-issue-created",
  name: "New Issue Created Event (Instant)",
  description: "Emit new event when an issue is created. Note that Jira supports only one webhook, if more sources are needed please use `New Event` source and select multiple events.",
  version: "0.0.14",
  type: "source",
  dedupe: "unique",
  ...common,
  methods: {
    ...common.methods,
    getEvents() {
      return [
        "jira:issue_created",
      ];
    },
  },
};

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
Jira	`jira`	`app`	This component uses the Jira app.
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.
Cloud ID	`cloudId`	`string`	Select a value from the drop down menu.
JQL Filter	`jqlFilter`	`string`	The JQL filter that specifies which issues the webhook is sent for, only a subset of JQL can be used, e.g. `project = P1` See supported JQL filters
Override Existing Webhooks	`overrideExistingWebhooks`	`boolean`	Override existing webhooks with this new Pipedream source's webhook. Recommend to set this to `true` if you have an existing Jira webhook that you no longer use and want to override with the new Pipedream source.

Trigger 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

Action#

Search Labels on Shipengine

Description:By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/list_labels).

Version:0.0.3

Key:shipengine-search-labels

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.

Action Code#

import app from "../../shipengine.app.mjs";
import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "shipengine-search-labels",
  name: "Search Labels",
  description: "By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/list_labels).",
  type: "action",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    app,
    labelStatus: {
      type: "string",
      label: "Label Status",
      description: "The status of the label. E.g. `processing`",
      options: constants.LABEL_STATUSES,
    },
    carrierId: {
      propDefinition: [
        app,
        "carrierId",
      ],
    },
    serviceCode: {
      propDefinition: [
        app,
        "serviceCode",
        ({ carrierId }) => ({
          carrierId,
        }),
      ],
    },
    trackingNumber: {
      label: "Tracking Number",
      description: "The tracking number associated with a shipment. E.g. `9405511899223197428490`",
      propDefinition: [
        app,
        "labelId",
        () => ({
          mapper: ({ tracking_number: value }) => value,
        }),
      ],
    },
    shipmentId: {
      propDefinition: [
        app,
        "shipmentId",
      ],
    },
  },
  async run({ $: step }) {
    const {
      labelStatus,
      serviceCode,
      carrierId,
      trackingNumber,
      shipmentId,
    } = this;

    const stream = this.app.getResourcesStream({
      resourcesFn: this.app.listLabels,
      resourcesFnArgs: {
        step,
        params: {
          label_status: labelStatus,
          service_code: serviceCode,
          carrier_id: carrierId,
          tracking_number: trackingNumber,
          shipment_id: shipmentId,
          page_size: constants.DEFAULT_LIMIT,
        },
      },
      resourcesName: "labels",
    });

    const resources = await utils.streamIterator(stream);

    step.export("$summary", `Successfully retrieved ${utils.summaryEnd(resources.length, "label")}.`);

    return resources;
  },
};

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
Shipengine	`app`	`app`	This component uses the Shipengine app.
Label Status	`labelStatus`	`string`	Select a value from the drop down menu:`processingcompletederrorvoided`
Carrier ID	`carrierId`	`string`	Select a value from the drop down menu.
Service Code	`serviceCode`	`string`	Select a value from the drop down menu.
Tracking Number	`trackingNumber`	`string`	Select a value from the drop down menu.
Shipment ID	`shipmentId`	`string`	Select a value from the drop down menu.

Action 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

More Ways to Connect Shipengine + Jira#

Other Popular Integrations#

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

Jira + Shipengine

Search Labels with Shipengine API on New Issue Created Event (Instant) from Jira API

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

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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