Find Lead with WhatConverts API on New Keyword Mention (Instant) from Slack API

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

Trigger workflow on

New Keyword Mention (Instant) from the Slack API

Next, do this

Find Lead with the WhatConverts 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 WhatConverts 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 Find Lead action
1. Connect your WhatConverts account
2. Optional- Select a Account ID
3. Optional- Select a Profile ID
4. Optional- Select a Lead Type
5. Optional- Select a Lead Status
6. Optional- Configure Start Date
7. Optional- Configure End Date
8. Optional- Select a Order
9. Optional- Select a Quotable
10. Optional- Select a Quote Value
11. Optional- Select a Sales Value
12. Optional- Configure Phone Number
13. Optional- Configure Email Address
14. Optional- Configure Spam
15. Optional- Configure Duplicate
16. Optional- Configure Lead Source
17. Optional- Configure Lead Medium
18. Optional- Configure Lead Campaign
19. Optional- Configure Lead Content
20. Optional- Configure Lead Keyword
21. Optional- Configure Max Results
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.7

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.7",
  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:

channels:historychannels:readchannels:writeemoji:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writereactions:readreactions:writereminders:readreminders:writestars:readteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:userfiles:write:usercommandsusers.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#

Find Lead on WhatConverts

Description:Find a lead in WhatConverts. [See the documentation](https://www.whatconverts.com/api/leads/#get-all-leads)

Version:0.0.1

Key:whatconverts-find-lead

View on GitHub

WhatConverts Overview#

The WhatConverts API allows you to track, manage, and report on leads and conversions from various marketing channels. With this API, you can automate the ingestion of lead data into your CRM, generate custom reports, and receive real-time alerts for new leads. When you implement this API within Pipedream, you can create powerful, serverless workflows that respond to events in WhatConverts, or trigger actions based on data from other apps.

Action Code#

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

export default {
  key: "whatconverts-find-lead",
  name: "Find Lead",
  description: "Find a lead in WhatConverts. [See the documentation](https://www.whatconverts.com/api/leads/#get-all-leads)",
  version: "0.0.1",
  type: "action",
  props: {
    whatconverts,
    accountId: {
      propDefinition: [
        whatconverts,
        "accountId",
      ],
    },
    profileId: {
      propDefinition: [
        whatconverts,
        "profileId",
        (c) => ({
          accountId: c.accountId,
        }),
      ],
    },
    leadType: {
      propDefinition: [
        whatconverts,
        "leadType",
      ],
    },
    leadStatus: {
      type: "string",
      label: "Lead Status",
      description: "Lead status to return for this request",
      options: [
        "repeat",
        "unique",
      ],
      optional: true,
    },
    startDate: {
      type: "string",
      label: "Start Date",
      description: "Start date for this request in date or date/time ISO 8601 format (UTC); `2015-11-10` or `2015-11-10T00:00:00Z`. Date range can include up to 400 days.",
      optional: true,
    },
    endDate: {
      type: "string",
      label: "End Date",
      description: "End date for this request in date or date/time ISO 8601 format (UTC); `2015-11-10` or `2015-11-10T00:00:00Z`. Date range can include up to 400 days.",
      optional: true,
    },
    order: {
      type: "string",
      label: "Order",
      description: "Order in which to return the leads by date created",
      options: [
        "asc",
        "desc",
      ],
      optional: true,
    },
    quotable: {
      type: "string",
      label: "Quotable",
      description: "Quotable type to return for this request",
      options: [
        "yes",
        "no",
        "pending",
        "not_set",
      ],
      optional: true,
    },
    quoteValue: {
      type: "string",
      label: "Quote Value",
      description: "Return leads that have a quote value",
      options: [
        "has_value",
        "no_value",
      ],
      optional: true,
    },
    salesValue: {
      type: "string",
      label: "Sales Value",
      description: "Return leads that have a sales value",
      options: [
        "has_value",
        "no_value",
      ],
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "Return leads for the contacts that have this E.164 formatted phone number",
      optional: true,
    },
    emailAddress: {
      type: "string",
      label: "Email Address",
      description: "Return leads for the contact that have this email address",
      optional: true,
    },
    spam: {
      type: "boolean",
      label: "Spam",
      description: "If `true` will return only spam leads",
      optional: true,
    },
    duplicate: {
      type: "boolean",
      label: "Duplicate",
      description: "If true will return only duplicate leads",
      optional: true,
    },
    leadSource: {
      type: "string",
      label: "Lead Source",
      description: "Return leads that have this lead source",
      optional: true,
    },
    leadMedium: {
      type: "string",
      label: "Lead Medium",
      description: "Return leads that have this lead medium",
      optional: true,
    },
    leadCampaign: {
      type: "string",
      label: "Lead Campaign",
      description: "Return leads that have this lead campaign",
      optional: true,
    },
    leadContent: {
      type: "string",
      label: "Lead Content",
      description: "Return leads that have this lead content",
      optional: true,
    },
    leadKeyword: {
      type: "string",
      label: "Lead Keyword",
      description: "Return leads that have this lead keyword",
      optional: true,
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "The maximum number of results to return. Default: 100, Maximum: 2500",
      optional: true,
      default: 100,
    },
  },
  async run({ $ }) {
    const { leads } = await this.whatconverts.listLeads({
      $,
      params: {
        profile_id: this.profileId,
        lead_type: this.leadType,
        lead_status: this.leadStatus,
        start_date: this.startDate,
        end_date: this.endDate,
        order: this.order,
        quotable: this.quotable,
        quote_value: this.quoteValue,
        sales_value: this.salesValue,
        phone_number: this.phoneNumber,
        email_address: this.emailAddress,
        spam: this.spam,
        duplicate: this.duplicate,
        lead_source: this.leadSource,
        lead_medium: this.leadMedium,
        lead_campaign: this.leadCampaign,
        lead_content: this.leadContent,
        lead_keyword: this.leadKeyword,
        leads_per_page: this.maxResults,
      },
    });

    $.export("$summary", `Found ${leads.length} lead${leads.length === 1
      ? ""
      : "s"}`);
    return leads;
  },
};

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
WhatConverts	`whatconverts`	`app`	This component uses the WhatConverts app.
Account ID	`accountId`	`integer`	Select a value from the drop down menu.
Profile ID	`profileId`	`integer`	Select a value from the drop down menu.
Lead Type	`leadType`	`string`	Select a value from the drop down menu:`appointmentchatemaileventotherphone_calltext_messagetransactionweb_form`
Lead Status	`leadStatus`	`string`	Select a value from the drop down menu:`repeatunique`
Start Date	`startDate`	`string`	Start date for this request in date or date/time ISO 8601 format (UTC); `2015-11-10` or `2015-11-10T00:00:00Z`. Date range can include up to 400 days.
End Date	`endDate`	`string`	End date for this request in date or date/time ISO 8601 format (UTC); `2015-11-10` or `2015-11-10T00:00:00Z`. Date range can include up to 400 days.
Order	`order`	`string`	Select a value from the drop down menu:`ascdesc`
Quotable	`quotable`	`string`	Select a value from the drop down menu:`yesnopendingnot_set`
Quote Value	`quoteValue`	`string`	Select a value from the drop down menu:`has_valueno_value`
Sales Value	`salesValue`	`string`	Select a value from the drop down menu:`has_valueno_value`
Phone Number	`phoneNumber`	`string`	Return leads for the contacts that have this E.164 formatted phone number
Email Address	`emailAddress`	`string`	Return leads for the contact that have this email address
Spam	`spam`	`boolean`	If `true` will return only spam leads
Duplicate	`duplicate`	`boolean`	If true will return only duplicate leads
Lead Source	`leadSource`	`string`	Return leads that have this lead source
Lead Medium	`leadMedium`	`string`	Return leads that have this lead medium
Lead Campaign	`leadCampaign`	`string`	Return leads that have this lead campaign
Lead Content	`leadContent`	`string`	Return leads that have this lead content
Lead Keyword	`leadKeyword`	`string`	Return leads that have this lead keyword
Max Results	`maxResults`	`integer`	The maximum number of results to return. Default: 100, Maximum: 2500

Action Authentication#

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

To retrieve your API Keys,

Navigate to your WhatConverts account and sign in
Click the dropdown on the top left, then click “Show Settings”
Go to “Master Integrations” > “API Keys” > “View Details”

Find Lead with WhatConverts API on New Keyword Mention (Instant) from Slack API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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