Create Company with Nutshell API on New Column from MySQL API

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

Trigger workflow on

New Column from the MySQL API

Next, do this

Create Company with the Nutshell 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 Nutshell 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 Create Company action
1. Connect your Nutshell account
2. Optional- Select a Industry Id
3. Optional- Select a Account Type Id
4. Optional- Select a Territory Id
5. Optional- Configure URLs
6. Optional- Configure Email
7. Optional- Configure Phones
8. Optional- Configure Address
9. Configure Company Name
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.5

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.5",
  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#

Create Company on Nutshell

Description:Creates a new company within Nutshell. [See the documentation](https://developers.nutshell.com/detail/class_core.html#a491d4330ca35e5403edd48a2cfd3b275)

Version:0.0.1

Key:nutshell-create-company

View on GitHub

Nutshell Overview#

The Nutshell API allows you to access and manage data within the Nutshell CRM platform, enabling you to automate tasks, sync information across apps, and build custom integrations. With Pipedream, these capabilities are harnessed through serverless workflows that can trigger actions within Nutshell or react to events, all with minimal setup. You can create leads, update contacts, manage sales processes, and more, all in a scalable and efficient manner.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import nutshell from "../../nutshell.app.mjs";

export default {
  key: "nutshell-create-company",
  name: "Create Company",
  description: "Creates a new company within Nutshell. [See the documentation](https://developers.nutshell.com/detail/class_core.html#a491d4330ca35e5403edd48a2cfd3b275)",
  version: "0.0.1",
  type: "action",
  props: {
    nutshell,
    industryId: {
      propDefinition: [
        nutshell,
        "industryId",
      ],
      optional: true,
    },
    accountTypeId: {
      propDefinition: [
        nutshell,
        "accountTypeId",
      ],
      optional: true,
    },
    territoryId: {
      propDefinition: [
        nutshell,
        "territoryId",
      ],
      optional: true,
    },
    url: {
      type: "string[]",
      label: "URLs",
      description: "The URLs of the company.",
      optional: true,
    },
    email: {
      propDefinition: [
        nutshell,
        "email",
      ],
      optional: true,
    },
    phone: {
      propDefinition: [
        nutshell,
        "phone",
      ],
    },
    address: {
      propDefinition: [
        nutshell,
        "address",
      ],
      optional: true,
    },
    companyName: {
      propDefinition: [
        nutshell,
        "companyName",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const { result: { Accounts: fields } } = await this.getCustomFields();
    const props = {};
    let i = 0;
    for (const field of fields) {
      i++;
      props[`customField_${i}`] = {
        type: "string",
        label: field.name,
        description: `Custom field ${i}.`,
        optional: true,
      };
    }
    return props;
  },
  methods: {
    async getCustomFields() {
      return await this.nutshell.post({
        method: "findCustomFields",
      });
    },
    async parseCustomFields(props) {
      const customFields = {};
      const { result: { Accounts } } = await this.getCustomFields();

      let i = 0;
      for (const field of Accounts) {
        i++;
        if (props[`customField_${i}`]) {
          customFields[field.name] = props[`customField_${i}`];
        }
      }
      return customFields;
    },
  },
  async run({ $ }) {
    const customFields = await this.parseCustomFields(this);
    const response = await this.nutshell.post({
      $,
      method: "newAccount",
      data: {
        params: {
          account: {
            name: this.companyName,
            industryId: this.industryId,
            accountTypeId: this.accountTypeId,
            territoryId: this.territoryId,
            location: this.location,
            url: this.url && parseObject(this.url),
            email: this.email && parseObject(this.email),
            phone: this.phone && parseObject(this.phone),
            address: this.address && parseObject(this.address),
            customFields,
          },
        },
      },
    });
    $.export("$summary", `Successfully created company with Id: ${response.result?.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
Nutshell	`nutshell`	`app`	This component uses the Nutshell app.
Industry Id	`industryId`	`string`	Select a value from the drop down menu.
Account Type Id	`accountTypeId`	`string`	Select a value from the drop down menu.
Territory Id	`territoryId`	`string`	Select a value from the drop down menu.
URLs	`url`	`string[]`	The URLs of the company.
Email	`email`	`string[]`	The email address of the company.
Phones	`phone`	`string[]`	The phone numbers of the company.
Address	`address`	`string[]`	A list of address objects. E.g. `{"address_1":"100 Second St.","address_2":"Apt. 4","address_3":"c/o Barclay Fowler","city":"Ann Arbor","state":"MI","postalCode": "48103","country": "US"}`
Company Name	`companyName`	`string`	The name of the company.

Action Authentication#

Nutshell uses OAuth authentication. When you connect your Nutshell account, Pipedream will open a popup window where you can sign into Nutshell and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Nutshell API.

Pipedream requests the following authorization scopes when you connect your account: