Get Record(s) with Knack API on New Row from MySQL API

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

Trigger workflow on

New Row from the MySQL API

Next, do this

Get Record(s) with the Knack 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 Knack action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Row trigger
1. Connect your MySQL account
2. Configure timer
3. Select a Table
4. Optional- Select a Column
Configure the Get Record(s) action
1. Connect your Knack account
2. Configure Object Key
3. Optional- Configure Record ID
4. Optional- Configure Sort Field
5. Optional- Select a Sort Order
6. Optional- Configure Filters
7. Optional- Select a Filter Type
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 Row on MySQL

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

Version:2.0.5

Key:mysql-new-row

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";

const { mysql } = common.props;

export default {
  ...common,
  key: "mysql-new-row",
  name: "New Row",
  description: "Emit new event when you add a new row to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)",
  type: "source",
  version: "2.0.5",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
    column: {
      propDefinition: [
        mysql,
        "column",
        (c) => ({
          table: c.table,
        }),
      ],
      optional: true,
    },
  },
  hooks: {
    /**
     * If column prop is left blank, get the table's primary key to use for ordering and deduping.
     * */
    async deploy() {
      const { table } = this;
      let column = this.column;

      if (!column) {
        const keyData = await this.mysql.getPrimaryKey({
          table,
        });
        column = keyData[0].Column_name;
      }

      this._setColumn(column);

      await this.listTopRows(column);
    },
  },
  methods: {
    ...common.methods,
    _getColumn() {
      return this.db.get("column");
    },
    _setColumn(column) {
      this.db.set("column", column);
    },
    async listResults() {
      const column = this._getColumn();
      await this.listRowResults(column);
    },
    iterateAndEmitEvents(rows) {
      const column = this._getColumn();
      for (const row of rows) {
        const meta = this.generateMeta(row, column);
        this.$emit(row, meta);
      }
    },
    generateMeta(row, column) {
      return {
        id: row[column],
        summary: `New Row Added ${column}: ${row[column]}`,
        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.
Column	`column`	`string`	Select a value from the drop down menu.

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 Record(s) on Knack

Description:Get one or more Records for a Knack object [(See docs here)](https://docs.knack.com/docs/retrieving-records)

Version:0.0.1

Key:knack-get-record

View on GitHub

Knack Overview#

The Knack API allows for robust interactions with your Knack database, enabling automation of data entry, retrieval, updates, and deletion. With Pipedream, you can leverage these capabilities to create seamless workflows that react to events in real-time, sync data across platforms, and enhance your database management without manual intervention. Think less about CRUD operations and more about the magic of connecting your Knack data to the digital tools ecosystem.

Action Code#

import base from "../common/base.mjs";
import { optionalRecordId as recordId } from "../common/props.mjs";

export default {
  ...base,
  key: "knack-get-record",
  name: "Get Record(s)",
  description:
    "Get one or more Records for a Knack object [(See docs here)](https://docs.knack.com/docs/retrieving-records)",
  version: "0.0.1",
  type: "action",
  props: {
    ...base.props,
    recordId,
    sortField: {
      type: "string",
      label: "Sort Field",
      optional: true,
      description: `The field key to sort the records by. Use in conjunction with \`Sort Order\`.
        \\
        Example value: \`field_1\`
        \\
        See [the Knack API docs](https://docs.knack.com/docs/sorting) for more information.`,
    },
    sortOrder: {
      type: "string",
      label: "Sort Order",
      optional: true,
      options: [
        {
          label: "Ascending",
          value: "asc",
        },
        {
          label: "Descending",
          value: "desc",
        },
      ],
      description: "The order to sort the records by, based on `Sort Field`.",
    },
    filters: {
      type: "string[]",
      label: "Filters",
      description: `One or more filters the returned records should match. Each filter should be a string representing a JSON object.
        \\
        Example value: \`{ "field": "field_1", "operator": "contains", "value": "my name" }\`
        \\
        See [the Knack API docs](https://docs.knack.com/docs/constructing-filters) for more information.`,
      optional: true,
    },
    filterType: {
      type: "string",
      label: "Filter Type",
      optional: true,
      options: [
        {
          label: "Match any filter",
          value: "or",
        },
        {
          label: "Match all filters",
          value: "and",
        },
      ],
      description: "If using multiple `Filters`, sets whether the returned records should match **any** or **all** filters specified.",
    },
  },
  methods: {
    ...base.methods,
    getBaseParams() {
      return {
        objectKey: this.objectKey,
        recordId: this.recordId,
      };
    },
    getQueryParams() {
      return {
        sortField: this.sortField,
        sortOrder: this.sortOrder,
        filters: this.filters,
        filterType: this.filterType,
      };
    },
  },
  async run({ $ }) {
    const response = await this.knack.getRecord(
      $,
      this.getBaseParams(),
      this.getQueryParams(),
    );

    $.export(
      "$summary",
      `Obtained ${
        response instanceof Array
          ? `${response.length} records`
          : "record"
      } successfully`,
    );

    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
Knack	`knack`	`app`	This component uses the Knack app.
Object Key	`objectKey`	`string`	The key of the object which this record belongs to. See the Knack API docs for more information.
Record ID	`recordId`	`string`	The ID of the record to retrieve. If not specified, all records for the specified object will be retrieved. See the Knack API docs for more information.
Sort Field	`sortField`	`string`	The field key to sort the records by. Use in conjunction with `Sort Order`. Example value: `field_1` See the Knack API docs for more information.
Sort Order	`sortOrder`	`string`	Select a value from the drop down menu:`{ "label": "Ascending", "value": "asc" }{ "label": "Descending", "value": "desc" }`
Filters	`filters`	`string[]`	One or more filters the returned records should match. Each filter should be a string representing a JSON object. Example value: `{ "field": "field_1", "operator": "contains", "value": "my name" }` See the Knack API docs for more information.
Filter Type	`filterType`	`string`	Select a value from the drop down menu:`{ "label": "Match any filter", "value": "or" }{ "label": "Match all filters", "value": "and" }`