Create or Update Company with Gainsight API on New Column from MySQL API

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

Trigger workflow on

New Column from the MySQL API

Next, do this

Create or Update Company with the Gainsight 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 Gainsight 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 or Update Company action
1. Connect your Gainsight account
2. Configure Name
3. Optional- Configure Industry
4. Optional- Configure Annual Recurring Revenue (ARR)
5. Optional- Configure Employees
6. Optional- Configure Life Cycle in Weeks
7. Optional- Configure Original Contract Date
8. Optional- Configure Renewal Date
9. Optional- Select a Stage
10. Optional- Select a Status
11. Optional- Configure Additional Options
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 or Update Company on Gainsight

Description:Create or update a company record. [See the documentation](https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Company_and_Relationship_API/Company_API_Documentation#Parameters)

Version:0.0.1

Key:gainsight_nxt-create-or-update-company

View on GitHub

Action Code#

import { parseObjectEntries } from "../../common/utils.mjs";
import app from "../../gainsight_nxt.app.mjs";

export default {
  key: "gainsight_nxt-create-or-update-company",
  name: "Create or Update Company",
  description: "Create or update a company record. [See the documentation](https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Company_and_Relationship_API/Company_API_Documentation#Parameters)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the company. If a company record with this name exists, it will be updated, otherwise a new one will be created.",
    },
    industry: {
      type: "string",
      label: "Industry",
      description: "The industry name of the company.",
      optional: true,
    },
    arr: {
      type: "string",
      label: "Annual Recurring Revenue (ARR)",
      description: "The annual recurring revenue of the company, as a currency value.",
      optional: true,
    },
    employees: {
      type: "integer",
      label: "Employees",
      description: "The number of employees the company has.",
      optional: true,
    },
    lifecycleInWeeks: {
      type: "integer",
      label: "Life Cycle in Weeks",
      description: "The number of weeks the entire process goes through.",
      optional: true,
    },
    originalContractDate: {
      type: "string",
      label: "Original Contract Date",
      description: "The date the engagement with the client started, in `YYYY-MM-DD` format.",
      optional: true,
    },
    renewalDate: {
      type: "string",
      label: "Renewal Date",
      description: "The upcoming renewal date of the contract, in `YYYY-MM-DD` format.",
      optional: true,
    },
    stage: {
      type: "string",
      label: "Stage",
      description: "The current stage of the company in the sales pipeline.",
      optional: true,
      options: [
        "New Customer",
        "Kicked Off",
        "Launched",
        "Adopting",
        "Will Churn",
        "Churn",
      ],
    },
    status: {
      type: "string",
      label: "Status",
      description: "The current status of the company.",
      optional: true,
      options: [
        "Active",
        "Inactive",
        "Churn",
      ],
    },
    additionalOptions: {
      type: "object",
      label: "Additional Options",
      description:
        "Additional parameters to send in the request. [See the documentation](https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Company_and_Relationship_API/Company_API_Documentation#Parameters) for available parameters. Values will be parsed as JSON where applicable.",
      optional: true,
    },
  },
  async run({ $ }) {
    const data = {
      records: [
        {
          Name: this.name,
          Industry: this.industry,
          ARR: this.arr,
          Employees: this.employees,
          LifecycleInWeeks: this.lifecycleInWeeks,
          OriginalContractDate: this.originalContractDate,
          RenewalDate: this.renewalDate,
          Stage: this.stage,
          Status: this.status,
          ...(this.additionalOptions && parseObjectEntries(this.additionalOptions)),
        },
      ],
    };

    let summary = "";
    let result;
    try {
      const updateReq = await this.app.updateCompany({
        $,
        data,
      });
      result = updateReq;
      summary = updateReq.result === true
        ? `Successfully updated company '${this.name}'`
        : `Error updating company '${this.name}'`;
    }
    catch (err) {
      const createReq = await this.app.createCompany({
        $,
        data,
      });
      result = createReq;
      summary = createReq.result === true
        ? `Successfully created company '${this.name}'`
        : `Error creating company '${this.name}'`;
    }

    $.export(
      "$summary",
      summary,
    );
    return result;
  },
};

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
Gainsight	`app`	`app`	This component uses the Gainsight app.
Name	`name`	`string`	The name of the company. If a company record with this name exists, it will be updated, otherwise a new one will be created.
Industry	`industry`	`string`	The industry name of the company.
Annual Recurring Revenue (ARR)	`arr`	`string`	The annual recurring revenue of the company, as a currency value.
Employees	`employees`	`integer`	The number of employees the company has.
Life Cycle in Weeks	`lifecycleInWeeks`	`integer`	The number of weeks the entire process goes through.
Original Contract Date	`originalContractDate`	`string`	The date the engagement with the client started, in `YYYY-MM-DD` format.
Renewal Date	`renewalDate`	`string`	The upcoming renewal date of the contract, in `YYYY-MM-DD` format.
Stage	`stage`	`string`	Select a value from the drop down menu:`New CustomerKicked OffLaunchedAdoptingWill ChurnChurn`
Status	`status`	`string`	Select a value from the drop down menu:`ActiveInactiveChurn`
Additional Options	`additionalOptions`	`object`	Additional parameters to send in the request. See the documentation for available parameters. Values will be parsed as JSON where applicable.