← Slack + Knack integrations

Get Record(s) with Knack API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for Knack, Slack and 900+ other apps remarkably fast.

Trigger workflow on
New Message In Channels (Instant) from the Slack API
Next, do this
Get Record(s) with the Knack API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

This integration creates a workflow with a Slack trigger and Knack action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New Message In Channels (Instant) trigger
    1. Connect your Slack account
    2. Optional- Select one or more Channels
    3. Configure slackApphook
    4. Optional- Configure Resolve Names
    5. Optional- Configure Ignore Bots
  3. Configure the Get Record(s) action
    1. Connect your Knack account
    2. Configure Object Key
    3. Optional- Configure Record ID
    4. Optional- Configure Sort Field
    5. Optional- Select a Sort Order
    6. Optional- Configure Filters
    7. Optional- Select a Filter Type
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source 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

Description:Emit new event when a new message is posted to one or more channels
Version:1.0.1
Key:slack-new-message-in-channels

Slack Overview

With the Slack API, you can build all sorts of integrations and applications to
make your work life easier. Here are just a few examples:

  • Automate posting updates to your team channel
  • Create a bot to answer common questions
  • Integrate with your existing tools and services
  • Build a custom dashboard to track your team's progress
  • Create a bot to handle scheduling and meeting requests
  • And much more!

Trigger Code

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

export default {
  ...common,
  key: "slack-new-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.1",
  description: "Emit new event when a new message is posted to one or more channels",
  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",
        ];
      },
    },
    resolveNames: {
      propDefinition: [
        common.props.slack,
        "resolveNames",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New message in channel";
    },
    async processEvent(event) {
      if (event.type !== "message") {
        console.log(`Ignoring event with unexpected type "${event.type}"`);
        return;
      }
      if (event.subtype != null && event.subtype != "bot_message" && event.subtype != "file_share") {
        // 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!!
        console.log("Ignoring message with subtype.");
        return;
      }
      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
        return;
      }
      if (this.resolveNames) {
        if (event.user) {
          event.user_id = event.user;
          event.user = await this.getUserName(event.user);
        } else if (event.bot_id) {
          event.bot = await this.getBotName(event.bot_id);
        }
        event.channel_id = event.channel;
        event.channel = await this.getConversationName(event.channel);
        if (event.team) {
          event.team_id = event.team;
          event.team = await this.getTeamName(event.team);
        }
      }
      return event;
    },
  },
};

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.
LabelPropTypeDescription
SlackslackappThis component uses the Slack app.
N/AnameCache$.service.dbThis component uses $.service.db to maintain state between component invocations.
Channelsconversationsstring[]Select a value from the drop down menu.
slackApphook$.interface.apphook
Resolve NamesresolveNamesboolean

Instead of returning channel, team, and user as IDs, return their human-readable names.

Ignore BotsignoreBotboolean

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

Description:Get one or more Records for a Knack object [(See docs here)](https://docs.knack.com/docs/retrieving-records)
Version:0.0.1
Key:knack-get-record

Action Code

import base from "../common/base.mjs";
import { optionalRecordId as recordId } from "../common/props.mjs";

export default {
  ...base,
  key: "knack-get-record",
  name: "Get Record(s)",
  description:
    "Get one or more Records for a Knack object [(See docs here)](https://docs.knack.com/docs/retrieving-records)",
  version: "0.0.1",
  type: "action",
  props: {
    ...base.props,
    recordId,
    sortField: {
      type: "string",
      label: "Sort Field",
      optional: true,
      description: `The field key to sort the records by. Use in conjunction with \`Sort Order\`.
        \\
        Example value: \`field_1\`
        \\
        See [the Knack API docs](https://docs.knack.com/docs/sorting) for more information.`,
    },
    sortOrder: {
      type: "string",
      label: "Sort Order",
      optional: true,
      options: [
        {
          label: "Ascending",
          value: "asc",
        },
        {
          label: "Descending",
          value: "desc",
        },
      ],
      description: "The order to sort the records by, based on `Sort Field`.",
    },
    filters: {
      type: "string[]",
      label: "Filters",
      description: `One or more filters the returned records should match. Each filter should be a string representing a JSON object.
        \\
        Example value: \`{ "field": "field_1", "operator": "contains", "value": "my name" }\`
        \\
        See [the Knack API docs](https://docs.knack.com/docs/constructing-filters) for more information.`,
      optional: true,
    },
    filterType: {
      type: "string",
      label: "Filter Type",
      optional: true,
      options: [
        {
          label: "Match any filter",
          value: "or",
        },
        {
          label: "Match all filters",
          value: "and",
        },
      ],
      description: "If using multiple `Filters`, sets whether the returned records should match **any** or **all** filters specified.",
    },
  },
  methods: {
    ...base.methods,
    getBaseParams() {
      return {
        objectKey: this.objectKey,
        recordId: this.recordId,
      };
    },
    getQueryParams() {
      return {
        sortField: this.sortField,
        sortOrder: this.sortOrder,
        filters: this.filters,
        filterType: this.filterType,
      };
    },
  },
  async run({ $ }) {
    const response = await this.knack.getRecord(
      $,
      this.getBaseParams(),
      this.getQueryParams(),
    );

    $.export(
      "$summary",
      `Obtained ${
        response instanceof Array
          ? `${response.length} records`
          : "record"
      } successfully`,
    );

    return response;
  },
};

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.

LabelPropTypeDescription
KnackknackappThis component uses the Knack app.
Object KeyobjectKeystring

The key of the object which this record belongs to.

See the Knack API docs for more information.

Record IDrecordIdstring

The ID of the record to retrieve.

If not specified, all records for the specified object will be retrieved.

See the Knack API docs for more information.

Sort FieldsortFieldstring

The field key to sort the records by. Use in conjunction with Sort Order.

Example value: field_1

See the Knack API docs for more information.

Sort OrdersortOrderstringSelect a value from the drop down menu:{ "label": "Ascending", "value": "asc" }{ "label": "Descending", "value": "desc" }
Filtersfiltersstring[]

One or more filters the returned records should match. Each filter should be a string representing a JSON object.

Example value: { "field": "field_1", "operator": "contains", "value": "my name" }

See the Knack API docs for more information.

Filter TypefilterTypestringSelect a value from the drop down menu:{ "label": "Match any filter", "value": "or" }{ "label": "Match all filters", "value": "and" }

Action Authentication

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

Object-based requests require at least two headers: an application ID - to identify to our servers the app whose records you are requesting - and an API key (which is specific to each app) to authenticate the request. See docs.

About Knack

Business app platform

More Ways to Connect Knack + Slack

Create Record with Knack API on New Message In Channels from Slack API
Slack + Knack
 
Try it
Delete Record with Knack API on New Message In Channels from Slack API
Slack + Knack
 
Try it
Update Record with Knack API on New Message In Channels from Slack API
Slack + Knack
 
Try it
Send Message to a Public Channel with Slack API on New Record from Knack API
Knack + Slack
 
Try it
Send Message to a Private Channel with Slack API on New Record from Knack API
Knack + Slack
 
Try it
New Message In Channels (Instant) from the Slack API

Emit new event when a new message is posted to one or more channels

 
Try it
New Direct Message (Instant) from the Slack API

Emit new event when a message was posted in a direct message channel

 
Try it
New Mention (Instant) from the Slack API

Emit new event when a username or specific keyword is mentioned in a channel

 
Try it
New Reaction Added (Instant) from the Slack API

Emit new event when a member has added an emoji reaction to an item

 
Try it
New Star Added (Instant) from the Slack API

Emit new event when a star is added to an item

 
Try it
Send Message to a Public Channel with the Slack API

Send a message to a public channel and customize the name and avatar of the bot that posts the message. See postMessage or scheduleMessage docs here

 
Try it
Send Message to a Private Channel with the Slack API

Send a message to a private channel and customize the name and avatar of the bot that posts the message. See postMessage or scheduleMessage docs here

 
Try it
Send a Direct Message with the Slack API

Send a direct message to a single user. See postMessage or scheduleMessage docs here

 
Try it
Send Message Using Block Kit with the Slack API

Send a message using Slack's Block Kit UI framework to a channel, group or user. See postMessage or scheduleMessage docs here

 
Try it
Reply to a Message Thread with the Slack API

Send a message as a threaded reply. See postMessage or scheduleMessage docs here

 
Try it