Get Status with Delivery Match API on New Column from MySQL API

Pipedream makes it easy to connect APIs for Delivery Match, MySQL and 3,000+ other apps remarkably fast.

Trigger workflow on

New Column from the MySQL API

Next, do this

Get Status with the Delivery Match 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 MySQL trigger and Delivery Match action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Column trigger
1. Connect your MySQL account
2. Configure timer
3. Select a Table
Configure the Get Status action
1. Connect your Delivery Match account
2. Optional- Select a Shipment ID
3. Optional- Select a Order Number
4. Optional- Configure Channel
5. Optional- Configure Date From
6. Optional- Configure Date To
7. Optional- Configure Is Incremental
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 Column on MySQL

Description:Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)

Version:2.0.6

Key:mysql-new-column

View on GitHub

MySQL Overview#

The MySQL application on Pipedream enables direct interaction with your MySQL databases, allowing you to perform CRUD operations—create, read, update, delete—on your data with ease. You can leverage these capabilities to automate data synchronization, report generation, and event-based triggers that kick off workflows in other apps. With Pipedream's serverless platform, you can connect MySQL to hundreds of other services without managing infrastructure, crafting complex code, or handling authentication.

Trigger Code#

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

export default {
  ...common,
  key: "mysql-new-column",
  name: "New Column",
  description:
    "Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)",
  type: "source",
  version: "2.0.6",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
  },
  methods: {
    ...common.methods,
    _getPreviousColumns() {
      return this.db.get("previousColumns");
    },
    _setPreviousColumns(previousColumns) {
      this.db.set("previousColumns", previousColumns);
    },
    async listResults() {
      const { table } = this;
      let previousColumns = this._getPreviousColumns() || [];
      const columns = await this.mysql.listNewColumns({
        table,
        previousColumns,
      });
      this.iterateAndEmitEvents(columns);

      const newColumnNames = columns
        .map((column) => column.Field)
        .filter((c) => !previousColumns.includes(c));

      previousColumns = previousColumns.concat(newColumnNames);
      this._setPreviousColumns(previousColumns);
    },
    generateMeta(column) {
      const columnName = column.Field;
      return {
        id: `${columnName}${this.table}`,
        summary: columnName,
        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
MySQL	`mysql`	`app`	This component uses the MySQL app.
	`timer`	`$.interface.timer`
Table	`table`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs

SSL Setup

Configure SSL on your MySQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications

About MySQL#

MySQL is an open-source relational database management system.

Action#

Get Status on Delivery Match

Description:Return all status event details of a shipment. [See the documentation](https://engine.deliverymatch.eu/documentation#/operations/post-getStatus)

Version:0.0.1

Key:delivery_march-get-status

View on GitHub

Action Code#

import deliveryMarch from "../../delivery_march.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  name: "Get Status",
  description: "Return all status event details of a shipment. [See the documentation](https://engine.deliverymatch.eu/documentation#/operations/post-getStatus)",
  key: "delivery_march-get-status",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    deliveryMarch,
    shipmentId: {
      propDefinition: [
        deliveryMarch,
        "shipmentId",
      ],
    },
    orderNumber: {
      propDefinition: [
        deliveryMarch,
        "orderNumber",
      ],
    },
    channel: {
      type: "string",
      label: "Channel",
      description: "The channel through which the shipments have been made. Example: `shopify`",
      optional: true,
    },
    dateFrom: {
      type: "string",
      label: "Date From",
      description: "The starting date for the shipment status event period. Example: `2023-01-16 15:30:11`",
      optional: true,
    },
    dateTo: {
      type: "string",
      label: "Date To",
      description: "The ending date for the shipment status event period. Example: `2023-01-16 15:30:11`",
      optional: true,
    },
    isIncremental: {
      type: "boolean",
      label: "Is Incremental",
      description: "If `true`, shows which status events have been received. If `false`, all status events will be returned.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.shipmentId && !this.orderNumber) {
      throw new ConfigurationError("Either shipment ID or order number must be provided.");
    }
    if (this.shipmentId && this.orderNumber) {
      throw new ConfigurationError("Either shipment ID or order number must be provided, not both.");
    }
    const response = await this.deliveryMarch.getStatus({
      $,
      data: {
        shipment: {
          id: this.shipmentId,
          orderNumber: this.orderNumber,
        },
        channel: this.channel,
        dateFrom: this.dateFrom,
        dateTo: this.dateTo,
        isIncremental: this.isIncremental,
      },
    });
    $.export("$summary", `Successfully retrieved status for shipment \`${this.shipmentId || this.orderNumber}\`.`);
    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
Delivery Match	`deliveryMarch`	`app`	This component uses the Delivery Match app.
Shipment ID	`shipmentId`	`integer`	Select a value from the drop down menu.
Order Number	`orderNumber`	`string`	Select a value from the drop down menu.
Channel	`channel`	`string`	The channel through which the shipments have been made. Example: `shopify`
Date From	`dateFrom`	`string`	The starting date for the shipment status event period. Example: `2023-01-16 15:30:11`
Date To	`dateTo`	`string`	The ending date for the shipment status event period. Example: `2023-01-16 15:30:11`
Is Incremental	`isIncremental`	`boolean`	If `true`, shows which status events have been received. If `false`, all status events will be returned.