Create or Update Custom Object with Gainsight API on New Product Event (Instant) from WooCommerce API

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

Trigger workflow on

New Product Event (Instant) from the WooCommerce API

Next, do this

Create or Update Custom Object 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 WooCommerce 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 Product Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create or Update Custom Object action
1. Connect your Gainsight account
2. Select a Custom Object
3. Configure infoBox
4. Configure Key Field(s)
5. Configure Field Values
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 Product Event (Instant) on WooCommerce

Description:Emit new event each time the specified product event(s) occur

Version:0.0.3

Key:woocommerce-new-product-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

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

export default {
  ...common,
  key: "woocommerce-new-product-event",
  name: "New Product Event (Instant)",
  description: "Emit new event each time the specified product event(s) occur",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listProducts({
        per_page: perPage,
        orderby: "date",
      });
    },
    getTopic(topicType) {
      return `product.${topicType}`;
    },
    generateMeta(eventType, {
      id, name, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Product "${name || id}" ${eventType}`,
        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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Event topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

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

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Create or Update Custom Object on Gainsight

Description:Create or update a custom object record. [See the documentation](https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Custom_Object_API/Gainsight_Custom_Object_API_Documentation#Insert_API)

Version:0.0.1

Key:gainsight_nxt-create-or-update-custom-object

View on GitHub

Action Code#

import app from "../../gainsight_nxt.app.mjs";

export default {
  key: "gainsight_nxt-create-or-update-custom-object",
  name: "Create or Update Custom Object",
  description: "Create or update a custom object record. [See the documentation](https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Custom_Object_API/Gainsight_Custom_Object_API_Documentation#Insert_API)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    objectName: {
      propDefinition: [
        app,
        "objectName",
      ],
    },
    infoBox: {
      type: "alert",
      alertType: "info",
      content: "Custom object fields may be suffixed with `__gc`, e.g. if you've named your field \"Object Name\", its key would be `Object_Name__gc`. Check the object configuration in the Gainsight platform for the correct field names.",
    },
    fields: {
      type: "string[]",
      label: "Key Field(s)",
      description: "The field(s) which identify this object (max 3), e.g. `fieldName1`. If a record with the same key field(s) exists, it will be updated, otherwise a new one will be created.",
    },
    fieldValues: {
      type: "object",
      label: "Field Values",
      description: "The record data to create or update, as key-value pairs.",
    },
  },
  async run({ $ }) {
    const { objectName } = this;
    const data = {
      records: [
        this.fieldValues,
      ],
    };

    let summary = "";
    let result;
    try {
      result = await this.app.updateCustomObject({
        $,
        objectName,
        data,
        params: {
          keys: this.fields.join?.() ?? this.fields,
        },
      });
      summary = result.result === true
        ? `Successfully updated custom object ${objectName}`
        : `Error updating custom object ${objectName}`;
    }
    catch (err) {
      result = await this.app.createCustomObject({
        $,
        objectName,
        data,
      });
      summary = result.result === true
        ? `Successfully created custom object ${objectName}`
        : `Error creating custom object ${objectName}`;
    }

    $.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.
Custom Object	`objectName`	`string`	Select a value from the drop down menu.
Key Field(s)	`fields`	`string[]`	The field(s) which identify this object (max 3), e.g. `fieldName1`. If a record with the same key field(s) exists, it will be updated, otherwise a new one will be created.
Field Values	`fieldValues`	`object`	The record data to create or update, as key-value pairs.

Action Authentication#

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