Create Tracking with AfterShip API on New Field in Document from MongoDB API

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

Trigger workflow on

New Field in Document from the MongoDB API

Next, do this

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

Select this integration
Configure the New Field in Document trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
4. Select a Collection
5. Select a Document
Configure the Create Tracking action
1. Connect your AfterShip account
2. Configure Tracking Number
3. Optional- Configure Slug
4. Optional- Configure Title
5. Optional- Configure SMSes
6. Optional- Configure Emails
7. Optional- Configure Customer Name
8. Optional- Configure Order ID
9. Optional- Configure Order ID Path
10. Optional- Configure Custom Fields
11. Optional- Configure Order Number
12. Optional- Select a Language
13. Optional- Configure Order Promised Delivery Date
14. Optional- Select a Delivery Type
15. Optional- Configure Pickup location
16. Optional- Configure Pickup Note
17. Optional- Configure Tracking Account Number
18. Optional- Configure Tracking Key
19. Optional- Configure Tracking Ship Date
20. Optional- Configure Origin Country ISO3
21. Optional- Configure Origin State
22. Optional- Configure Origin City
23. Optional- Configure Origin Postal Code
24. Optional- Configure Origin Raw Location
25. Optional- Configure Destination Country ISO3
26. Optional- Configure Destination State
27. Optional- Configure Destination City
28. Optional- Configure Note
29. Optional- Configure Order Date
30. Optional- Configure Shipment Type
31. Optional- Configure Shipment Tags
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 Field in Document on MongoDB

Description:Emit new an event when a new field is added to a document

Version:0.0.7

Key:mongodb-new-field-in-document

View on GitHub

MongoDB Overview#

The MongoDB API provides powerful capabilities to interact with a MongoDB database, allowing you to perform CRUD (Create, Read, Update, Delete) operations, manage databases, and execute sophisticated queries. With Pipedream, you can harness these abilities to automate tasks, sync data across various apps, and react to events in real-time. It’s a combo that’s particularly potent for managing data workflows, syncing application states, or triggering actions based on changes to your data.

Trigger Code#

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

export default {
  ...common,
  key: "mongodb-new-field-in-document",
  name: "New Field in Document",
  description: "Emit new an event when a new field is added to a document",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        common.props.mongodb,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    document: {
      propDefinition: [
        common.props.mongodb,
        "document",
        (c) => ({
          database: c.database,
          collection: c.collection,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getFields() {
      return this.db.get("fields");
    },
    _setFields(fields) {
      this.db.set("fields", fields);
    },
    isRelevant(key, fields) {
      return !fields.includes(key);
    },
    async processEvent(client, ts) {
      const fields = this._getFields() || [];
      const collection = this.mongodb.getCollection(client, this.database, this.collection);
      const documents = await this.mongodb.listDocuments(collection);
      const doc = documents.find((obj) => {
        return obj._id == this.document;
      });
      const keys = Object.keys(doc);
      for (const key of keys) {
        if (!this.isRelevant(key, fields)) {
          continue;
        }
        fields.push(key);
        this.emitEvent(key, ts);
      }
      this._setFields(fields);
    },
    generateMeta(key, ts) {
      return {
        id: key,
        summary: `New Field ${key}`,
        ts,
      };
    },
  },
};

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
MongoDB	`mongodb`	`app`	This component uses the MongoDB app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Database	`database`	`string`	Select a value from the drop down menu.
Collection	`collection`	`string`	Select a value from the drop down menu.
Document	`document`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Before you connect to your Mongo database from Pipedream, please make sure your database is accessible from the public internet. You may need to add a firewall rule allowing connections from 0.0.0.0/0.

Then, enter the details of your Mongo host / database below.

About MongoDB#

MongoDB is an open source NoSQL database management program.

Action#

Create Tracking on AfterShip

Description:Creates a tracking. [See the documentation](https://www.aftership.com/docs/api/4/trackings/post-trackings)

Version:0.1.0

Key:aftership-create-tracking

View on GitHub

AfterShip Overview#

The AfterShip API on Pipedream allows you to seamlessly track shipments across various carriers, get real-time updates, and manage delivery exceptions. It's a gold mine for automating post-purchase customer communication and optimizing logistics operations. By integrating with AfterShip, you can create workflows that trigger upon shipment status changes, delays, or successful deliveries, and connect these events with other apps to streamline your e-commerce processes.

Action Code#

import aftership from "../../aftership.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import common from "../common/common.mjs";

export default {
  ...common,
  key: "aftership-create-tracking",
  name: "Create Tracking",
  description: "Creates a tracking. [See the documentation](https://www.aftership.com/docs/api/4/trackings/post-trackings)",
  version: "0.1.0",
  type: "action",
  props: {
    aftership,
    trackingNumber: {
      propDefinition: [
        aftership,
        "trackingNumber",
      ],
    },
    ...common.props,
    shipmentTags: {
      propDefinition: [
        aftership,
        "shipmentTags",
      ],
    },
  },
  async run({ $ }) {
    if (this.trackingNumber.length < 4 || this.trackingNumber.length > 100) {
      throw new ConfigurationError("We only accept tracking numbers with length from 4 to 100");
    }
    const response = await this.aftership.createTracking({
      $,
      data: {
        tracking: this.getData(),
      },
    });

    $.export("$summary", `Successfully created tracking with ID ${response.data.tracking.id}`);
    return response;
  },
};

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
AfterShip	`aftership`	`app`	This component uses the AfterShip app.
Tracking Number	`trackingNumber`	`string`	The tracking number of the shipment.
Slug	`slug`	`string`	The unique code of the courier. Get courier codes here.
Title	`title`	`string`	By default this field shows the `tracking_number`, but you can customize it as you wish with any info (e.g. the order number).
SMSes	`smses`	`string[]`	The phone number(s) to receive sms notifications. Enter `+` andarea `code before` phone number. Accept either array or comma separated as input. Supports up to 3 phone numbers.
Emails	`emails`	`string[]`	Email address(es) to receive email notifications. Accept either array or comma separated as input. Supports up to 3 email addresses.
Customer Name	`customerName`	`string`	Customer name of the tracking.
Order ID	`orderId`	`string`	A globally-unique identifier for the order.
Order ID Path	`orderIdPath`	`string`	The URL for the order in your system or store.
Custom Fields	`customFields`	`object`	Custom fields that accept an object with string field. In order to protect the privacy of your customers, do not include any personal data in custom fields.
Order Number	`orderNumber`	`string`	A unique, human-readable identifier for the order.
Language	`language`	`string`	Select a value from the drop down menu:`{ "value": "ab", "label": "Abkhazian" }{ "value": "aa", "label": "Afar" }{ "value": "af", "label": "Afrikaans" }{ "value": "ak", "label": "Akan" }{ "value": "sq", "label": "Albanian" }{ "value": "am", "label": "Amharic" }{ "value": "ar", "label": "Arabic" }{ "value": "an", "label": "Aragonese" }{ "value": "hy", "label": "Armenian" }{ "value": "as", "label": "Assamese" }{ "value": "av", "label": "Avaric" }{ "value": "ae", "label": "Avestan" }{ "value": "ay", "label": "Aymara" }{ "value": "az", "label": "Azerbaijani" }{ "value": "bm", "label": "Bambara" }{ "value": "ba", "label": "Bashkir" }{ "value": "eu", "label": "Basque" }{ "value": "be", "label": "Belarusian" }{ "value": "bn", "label": "Bengali (Bangla)" }{ "value": "bh", "label": "Bihari" }{ "value": "bi", "label": "Bislama" }{ "value": "bs", "label": "Bosnian" }{ "value": "br", "label": "Breton" }{ "value": "bg", "label": "Bulgarian" }{ "value": "my", "label": "Burmese" }{ "value": "ca", "label": "Catalan" }{ "value": "ch", "label": "Chamorro" }{ "value": "ce", "label": "Chechen" }{ "value": "ny", "label": "Chichewa, Chewa, Nyanja" }{ "value": "zh", "label": "Chinese" }{ "value": "zh-Hans", "label": "Chinese (Simplified)" }{ "value": "zh-Hant", "label": "Chinese (Traditional)" }{ "value": "cv", "label": "Chuvash" }{ "value": "kw", "label": "Cornish" }{ "value": "co", "label": "Corsican" }{ "value": "cr", "label": "Cree" }{ "value": "hr", "label": "Croatian" }{ "value": "cs", "label": "Czech" }{ "value": "da", "label": "Danish" }{ "value": "dv", "label": "Divehi, Dhivehi, Maldivian" }{ "value": "nl", "label": "Dutch" }{ "value": "dz", "label": "Dzongkha" }{ "value": "en", "label": "English" }{ "value": "eo", "label": "Esperanto" }{ "value": "et", "label": "Estonian" }{ "value": "ee", "label": "Ewe" }{ "value": "fo", "label": "Faroese" }{ "value": "fj", "label": "Fijian" }{ "value": "fi", "label": "Finnish" }{ "value": "fr", "label": "French" }{ "value": "ff", "label": "Fula, Fulah, Pulaar, Pular" }{ "value": "gl", "label": "Galician" }{ "value": "gd", "label": "Gaelic (Scottish)" }{ "value": "gv", "label": "Gaelic (Manx), Manx" }{ "value": "ka", "label": "Georgian" }{ "value": "de", "label": "German" }{ "value": "el", "label": "Greek" }{ "value": "kl", "label": "Kalaallisut, Greenlandic" }{ "value": "gn", "label": "Guarani" }{ "value": "gu", "label": "Gujarati" }{ "value": "ht", "label": "Haitian Creole" }{ "value": "ha", "label": "Hausa" }{ "value": "he", "label": "Hebrew" }{ "value": "hz", "label": "Herero" }{ "value": "hi", "label": "Hindi" }{ "value": "ho", "label": "Hiri motu" }{ "value": "hu", "label": "Hungarian" }{ "value": "is", "label": "Icelandic" }{ "value": "io", "label": "Ido" }{ "value": "ig", "label": "Igbo" }{ "value": "id", "label": "Indonesian" }{ "value": "ia", "label": "Interlingua" }{ "value": "ie", "label": "Interlingue" }{ "value": "iu", "label": "Inuktitut" }{ "value": "ik", "label": "Inupiak" }{ "value": "ga", "label": "Irish" }{ "value": "it", "label": "Italian" }{ "value": "ja", "label": "Japanese" }{ "value": "jv", "label": "Javanese" }{ "value": "kn", "label": "Kannada" }{ "value": "kr", "label": "Kanuri" }{ "value": "ks", "label": "Kashmiri" }{ "value": "kk", "label": "Kazakh" }{ "value": "km", "label": "Khmer" }{ "value": "ki", "label": "Kikuyu" }{ "value": "rw", "label": "Kinyarwanda (Rwanda)" }{ "value": "rn", "label": "Kirundi" }{ "value": "ky", "label": "Kyrgyz" }{ "value": "kv", "label": "Komi" }{ "value": "kg", "label": "Kongo" }{ "value": "ko", "label": "Korean" }{ "value": "ku", "label": "Kurdish" }{ "value": "kj", "label": "Kwanyama" }{ "value": "lo", "label": "Lao" }{ "value": "la", "label": "Latin" }{ "value": "lv", "label": "Latvian (Lettish)" }{ "value": "li", "label": "Limburgish ( Limburger)" }{ "value": "ln", "label": "Lingala" }{ "value": "lt", "label": "Lithuanian" }{ "value": "lu", "label": "Luga-Katanga" }{ "value": "lg", "label": "Luganda, Ganda" }{ "value": "lb", "label": "Luxembourgish" }{ "value": "mk", "label": "Macedonian" }{ "value": "mg", "label": "Malagasy" }{ "value": "ms", "label": "Malay" }{ "value": "ml", "label": "Malayalam" }{ "value": "mt", "label": "Maltese" }{ "value": "mi", "label": "Maori" }{ "value": "mr", "label": "Marathi" }{ "value": "mh", "label": "Marshallese" }{ "value": "mn", "label": "Mongolian" }{ "value": "na", "label": "Nauru" }{ "value": "nv", "label": "Navajo" }{ "value": "ng", "label": "Ndonga" }{ "value": "nd", "label": "Northern Ndebele" }{ "value": "ne", "label": "Nepali" }{ "value": "no", "label": "Norwegian" }{ "value": "nb", "label": "Norwegian bokmål" }{ "value": "nn", "label": "Norwegian nynorsk" }{ "value": "ii", "label": "Nuosu, Sichuan Yi" }{ "value": "oc", "label": "Occitan" }{ "value": "oj", "label": "Ojibwe" }{ "value": "cu", "label": "Old Church Slavonic, Old Bulgarian" }{ "value": "or", "label": "Oriya" }{ "value": "om", "label": "Oromo (Afaan Oromo)" }{ "value": "os", "label": "Ossetian" }{ "value": "pi", "label": "Pāli" }{ "value": "ps", "label": "Pashto, Pushto" }{ "value": "fa", "label": "Persian (Farsi)" }{ "value": "pl", "label": "Polish" }{ "value": "pt", "label": "Portuguese" }{ "value": "pa", "label": "Punjabi (Eastern)" }{ "value": "qu", "label": "Quechua" }{ "value": "rm", "label": "Romansh" }{ "value": "ro", "label": "Romanian" }{ "value": "ru", "label": "Russian" }{ "value": "se", "label": "Sami" }{ "value": "sm", "label": "Samoan" }{ "value": "sg", "label": "Sango" }{ "value": "sa", "label": "Sanskrit" }{ "value": "sr", "label": "Serbian" }{ "value": "st", "label": "Sesotho" }{ "value": "tn", "label": "Setswana" }{ "value": "sn", "label": "Shona" }{ "value": "sd", "label": "Sindhi" }{ "value": "si", "label": "Sinhalese" }{ "value": "ss", "label": "Siswati, Swati" }{ "value": "sk", "label": "Slovak" }{ "value": "sl", "label": "Slovenian" }{ "value": "so", "label": "Somali" }{ "value": "nr", "label": "Southern Ndebele" }{ "value": "es", "label": "Spanish" }{ "value": "su", "label": "Sundanese" }{ "value": "sw", "label": "Swahili (Kiswahili)" }{ "value": "sv", "label": "Swedish" }{ "value": "tl", "label": "Tagalog" }{ "value": "ty", "label": "Tahitian" }{ "value": "tg", "label": "Tajik" }{ "value": "ta", "label": "Tamil" }{ "value": "tt", "label": "Tatar" }{ "value": "te", "label": "Telugu" }{ "value": "th", "label": "Thai" }{ "value": "bo", "label": "Tibetan" }{ "value": "ti", "label": "Tigrinya" }{ "value": "to", "label": "Tonga" }{ "value": "ts", "label": "Tsonga" }{ "value": "tr", "label": "Turkish" }{ "value": "tk", "label": "Turkmen" }{ "value": "tw", "label": "Twi" }{ "value": "ug", "label": "Uyghur" }{ "value": "uk", "label": "Ukrainian" }{ "value": "ur", "label": "Urdu" }{ "value": "uz", "label": "Uzbek" }{ "value": "ve", "label": "Venda" }{ "value": "vi", "label": "Vietnamese" }{ "value": "vo", "label": "Volapük" }{ "value": "wa", "label": "Wallon" }{ "value": "cy", "label": "Welsh" }{ "value": "wo", "label": "Wolof" }{ "value": "fy", "label": "Western Frisian" }{ "value": "xh", "label": "Xhosa" }{ "value": "yi", "label": "Yiddish" }{ "value": "yo", "label": "Yoruba" }{ "value": "za", "label": "Zhuang, Chuang" }{ "value": "zu", "label": "Zulu" }`
Order Promised Delivery Date	`orderPromisedDeliveryDate`	`string`	The promised delivery date of the order. It uses the format `YYYY-MM-DD`.
Delivery Type	`deliveryType`	`string`	Select a value from the drop down menu:`pickup_at_storepickup_at_courierdoor_to_door`
Pickup location	`pickupLocation`	`string`	Shipment pickup location for receiver.
Pickup Note	`pickupNote`	`string`	Shipment pickup note for receiver.
Tracking Account Number	`trackingAccountNumber`	`string`	The shipper's carrier account number. Refer to this article on additional tracking fields for more details.
Tracking Key	`trackingKey`	`string`	A type of tracking credential required by some carriers. Refer to this article on additional tracking fields for more details.
Tracking Ship Date	`trackingShipDate`	`string`	The date the shipment was sent, using the format `YYYYMMDD`. Refer to this article on additional tracking fields for more details.
Origin Country ISO3	`originCountryIso3`	`string`	The ISO Alpha-3 code (3 letters) for the origin country/region. E.g. `USA` for the United States. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Origin State	`originState`	`string`	The state of the sender's address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Origin City	`originCity`	`string`	The city of the sender's address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Origin Postal Code	`originPostalCode`	`string`	The postal of the sender's address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Origin Raw Location	`originRawLocation`	`string`	The sender address that the shipment is shipping from. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Destination Country ISO3	`destinationCountryIso3`	`string`	The ISO Alpha-3 code (3 letters) for the destination country/region. E.g. `USA` for the United States. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Destination State	`destinationState`	`string`	The state of the recipient's address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Destination City	`destinationCity`	`string`	The city of the recipient's address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Note	`note`	`string`	Text field for the note.
Order Date	`orderDate`	`string`	Order date in YYYY-MM-DDTHH:mm:ssZ format. e.g. `2021-07-26T11:23:51-05:00`
Shipment Type	`shipmentType`	`string`	The carrier service type for the shipment. If you provide info for this field, AfterShip will not update it with info from the carrier.
Shipment Tags	`shipmentTags`	`string[]`	Used to add tags to your shipments to help categorize and filter them easily. Max 50 items.