Get Company Financials with Polygon API on New Keyword Mention (Instant) from Slack API

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

Trigger workflow on

New Keyword Mention (Instant) from the Slack API

Next, do this

Get Company Financials with the Polygon 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 Polygon 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 Get Company Financials action
1. Connect your Polygon account
2. Select a Stock Ticker
3. Optional- Configure Filing Date
4. Optional- Configure Period Of Report Date
5. Optional- Select a Timeframe
6. Optional- Select a Order
7. Optional- Configure Limit
8. Optional- Select a Sort
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.6

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

Get Company Financials on Polygon

Description:Retrieves financial details for a specific company by stock ticker. [See the documentation](https://polygon.io/docs/stocks/get_vx_reference_financials).

Version:0.0.1

Key:polygon-get-company-financials

View on GitHub

Polygon Overview#

The Polygon API grants access to a wealth of financial data, including real-time and historical stock prices, trade data, and more. Within Pipedream's serverless integration platform, you can tap into Polygon to create powerful workflows. With Pipedream, you can easily connect Polygon to hundreds of other apps, automate financial data processing, send stock alerts, or synchronize market data with databases or spreadsheets, all in real-time.

Action Code#

import {
  SORT_HISTORICAL_OPTIONS,
  SORT_OPTIONS, TIMEFRAME_OPTIONS,
} from "../../common/constants.mjs";
import polygon from "../../polygon.app.mjs";

export default {
  key: "polygon-get-company-financials",
  name: "Get Company Financials",
  description: "Retrieves financial details for a specific company by stock ticker. [See the documentation](https://polygon.io/docs/stocks/get_vx_reference_financials).",
  version: "0.0.1",
  type: "action",
  props: {
    polygon,
    stockTicker: {
      propDefinition: [
        polygon,
        "stockTicker",
      ],
    },
    filingDate: {
      type: "string",
      label: "Filing Date",
      description: "Query by the date when the filing with financials data was filed in **YYYY-MM-DD** format.",
      optional: true,
    },
    periodOfReportDate: {
      type: "string",
      label: "Period Of Report Date",
      description: "The period of report for the filing with financials data in **YYYY-MM-DD** format.",
      optional: true,
    },
    timeframe: {
      type: "string",
      label: "Timeframe",
      description: "Query by timeframe. Annual financials originate from 10-K filings, and quarterly financials originate from 10-Q filings. Note: Most companies do not file quarterly reports for Q4 and instead include those financials in their annual report, so some companies my not return quarterly financials for Q4",
      options: TIMEFRAME_OPTIONS,
      optional: true,
    },
    order: {
      type: "string",
      label: "Order",
      description: "Order results based on the `Sort` field.",
      options: SORT_OPTIONS,
      optional: true,
    },
    limit: {
      type: "integer",
      label: "Limit",
      description: "Limit the number of results returned.",
      optional: true,
      min: 1,
      max: 100,
      default: 10,
    },
    sort: {
      type: "string",
      label: "Sort",
      description: "Sort field used for ordering",
      options: SORT_HISTORICAL_OPTIONS,
      optional: true,
    },
  },
  async run({ $ }) {
    const financialDetails = await this.polygon.getFinancialDetails({
      $,
      params: {
        ticker: this.stockTicker,
        filing_date: this.filingDate,
        period_of_report_date: this.periodOfReportDate,
        timeframe: this.timeframe,
        order: this.order,
        limit: this.limit,
        sort: this.sort,
      },
    });
    $.export("$summary", `Successfully retrieved financial details for ${this.stockTicker}`);
    return financialDetails;
  },
};

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
Polygon	`polygon`	`app`	This component uses the Polygon app.
Stock Ticker	`stockTicker`	`string`	Select a value from the drop down menu.
Filing Date	`filingDate`	`string`	Query by the date when the filing with financials data was filed in YYYY-MM-DD format.
Period Of Report Date	`periodOfReportDate`	`string`	The period of report for the filing with financials data in YYYY-MM-DD format.
Timeframe	`timeframe`	`string`	Select a value from the drop down menu:`annualquarterlyttm`
Order	`order`	`string`	Select a value from the drop down menu:`ascdesc`
Limit	`limit`	`integer`	Limit the number of results returned.
Sort	`sort`	`string`	Select a value from the drop down menu:`filing_dateperiod_of_report_date`

Get Company Financials with Polygon API on New Keyword Mention (Instant) from Slack API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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