Run Node Code with Node API on New Tracking Event (Instant) from Shipengine API

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

Trigger workflow on

New Tracking Event (Instant) from the Shipengine API

Next, do this

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

Select this integration
Configure the New Tracking Event (Instant) trigger
1. Connect your Shipengine account
Configure the Run Node Code action
1. Connect your Node account
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 Tracking Event (Instant) on Shipengine

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

Version:0.0.2

Key:shipengine-new-tracking-event

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/webhook.mjs";

export default {
  ...common,
  key: "shipengine-new-tracking-event",
  name: "New Tracking Event (Instant)",
  description: "Emit new event when a new event is tracked. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/create_webhook).",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEvent() {
      return "track";
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.occurred_at);
      return {
        id: ts,
        ts,
        summary: `New Tracking Event at ${resource.occurred_at}`,
      };
    },
    processEvents(response) {
      const {
        events: resources,
        ...otherProps
      } = response;

      resources
        .reverse()
        .forEach((resource) =>
          this.$emit({
            ...otherProps,
            ...resource,
          }, this.generateMeta(resource)));
    },
  },
};

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

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#

Run Node Code on Node

Description:Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.

Version:0.0.2

Key:node-run-node-code

View on GitHub

Node Overview#

Develop, run and deploy your Node.js code in Pipedream workflows, using it between no-code steps, with connected accounts, or integrate Data Stores and File Stores.

This includes installing NPM packages, within your code without having to manage a package.json file or running npm install.

Below is an example of installing the axios package in a Pipedream Node.js code step. Pipedream imports the axios package, performs the API request, and shares the response with subsequent workflow steps:

Action Code#

import node from "../../node.app.mjs";

export default {
  name: "Run Node Code",
  version: "0.0.2",
  key: "node-run-node-code",
  description: "Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.",
  props: {
    node,
  },
  type: "action",
  methods: {},
  async run({
    steps, $,
  }) {
    // Return data to use it in future steps
    return steps.trigger.event;
  },
};

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
Node	`node`	`app`	This component uses the Node app.

Action Authentication#

The Node API does not require authentication.

About Node#

Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.

More Ways to Connect Node + Shipengine#

Other Popular Integrations#

Run Node Code with Node API on New Shipping Label Created from Shipengine API

Shipengine + Node

Try it

Popular Triggers#

New Shipping Label Created from the Shipengine API

Emit new event when a new label is shipped. See the docs.

Try it

New Tracking Event (Instant) from the Shipengine API

Emit new event when a new event is tracked. See the docs.

Try it

Popular Actions#

Find Tracking Status with the Shipengine API

Retrieves package tracking information. See the docs.

Try it

Search Labels with the Shipengine API

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.

Try it

Start Tracking a Package with the Shipengine API

Allows you to subscribe to tracking updates for a package. See the docs.

Try it

Validate An Address with the Shipengine API

Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. See the docs.

Try it

Run Node Code with the Node API

Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the Pipedream Node docs to learn more.

Try it