Create or Update Company with Gainsight API on New Keyword Mention (Instant) from Slack API

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

Trigger workflow on

New Keyword Mention (Instant) from the Slack 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 Slack 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 Keyword Mention (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Configure Keyword
5. Optional- Configure Ignore Bots
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 Keyword Mention (Instant) on Slack

Description:Emit new event when a specific keyword is mentioned in a channel

Version:0.0.5

Key:slack-new-keyword-mention

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. Once you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Trigger Code#

import common from "../common/base.mjs";
import constants from "../common/constants.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "slack-new-keyword-mention",
  name: "New Keyword Mention (Instant)",
  version: "0.0.5",
  description: "Emit new event when a specific keyword is mentioned in a channel",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Select one or more channels to monitor for new messages.",
      optional: true,
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return this.conversations || [
          "message",
        ];
      },
    },
    keyword: {
      propDefinition: [
        common.props.slack,
        "keyword",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
  },
  hooks: {
    ...common.hooks,
    async deploy() {
      // emit historical events
      const messages = await this.getMatches({
        query: this.keyword,
        sort: "timestamp",
      });
      const filteredMessages = this.conversations?.length > 0
        ? messages.filter((message) => this.conversations.includes(message.channel.id))
        : messages;
      await this.emitHistoricalEvents(filteredMessages.slice(-25).reverse());
    },
  },
  methods: {
    ...common.methods,
    async getMatches(params) {
      return (await this.slack.searchMessages(params)).messages.matches || [];
    },
    async emitHistoricalEvents(messages) {
      for (const message of messages) {
        const event = await this.processEvent({
          ...message,
          subtype: message.subtype || constants.SUBTYPE.PD_HISTORY_MESSAGE,
        });
        if (event) {
          if (!event.client_msg_id) {
            event.pipedream_msg_id = `pd_${Date.now()}_${Math.random().toString(36)
              .substr(2, 10)}`;
          }

          this.$emit(event, {
            id: event.client_msg_id || event.pipedream_msg_id,
            summary: this.getSummary(event),
            ts: event.event_ts || Date.now(),
          });
        }
      }
    },
    getSummary() {
      return "New keyword mention received";
    },
    async processEvent(event) {
      const {
        type: msgType,
        subtype,
        bot_id: botId,
        text,
      } = event;

      if (msgType !== "message") {
        console.log(`Ignoring event with unexpected type "${msgType}"`);
        return;
      }

      // This source is designed to just emit an event for each new message received.
      // Due to inconsistencies with the shape of message_changed and message_deleted
      // events, we are ignoring them for now. If you want to handle these types of
      // events, feel free to change this code!!
      if (subtype && !constants.ALLOWED_SUBTYPES.includes(subtype)) {
        console.log(`Ignoring message with subtype. "${subtype}"`);
        return;
      }

      if ((this.ignoreBot) && (subtype === constants.SUBTYPE.BOT_MESSAGE || botId)) {
        return;
      }

      let emitEvent = false;
      if (text.indexOf(this.keyword) !== -1) {
        emitEvent = true;
      } else if (subtype === constants.SUBTYPE.PD_HISTORY_MESSAGE) {
        emitEvent = true;
      }

      if (emitEvent) {
        return event;
      }
    },
  },
  sampleEmit,
};

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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`
Keyword	`keyword`	`string`	Keyword to monitor
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots

Trigger Authentication#

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

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

bookmarks:writecalls:readcalls:writechannels:historychannels:readchannels:writednd:readdnd:writeemoji:readfiles:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writepins:readpins:writereactions:readreactions:writereminders:readreminders:writeremote_files:readremote_files:sharestars:readstars:writeteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:usercommandsfiles:write:userusers.profile:writeusers.profile:readsearch:read

About Slack#

Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

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.

Create or Update Company with Gainsight API on New Keyword Mention (Instant) from Slack API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular