← Discord Bot + Knack integrations

Get Record(s) with Knack API on New Message in Channel from Discord Bot API

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

Trigger workflow on
New Message in Channel from the Discord Bot 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 Discord Bot 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 Channel trigger
    1. Connect your Discord Bot account
    2. Select a Guild
    3. Select one or more Channels
    4. Optional- Configure Emit messages as a single event
    5. Configure timer
  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 for each message posted to one or more channels
Version:0.0.5
Key:discord_bot-new-message-in-channel

Discord Bot Overview

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

Getting Started

To use the Discord Bot integration, you'll need to create a Discord bot and add that bot to your server(s). Watch the 4 minute video below for a short tutorial:

  1. Create a new Discord Developer Application
  2. Within your new application, create a Bot
  3. Define the permissions you'd like the bot to have access to
  4. Open the OAuth URL generator tool under the OAuth2 menu
  5. Select the bot auth scope
  6. Copy and paste the URL into a new window
  7. Accept the permissions to install the bot on your server

Not sure if you need to use the Discord or the Discord Bot integration for your workflow? Here's are the general similarities and differences:

Discord and Discord Bot actions and triggers can both:

  • Listen to events on Discord channels, guilds, etc.
  • Perform actions like sending messages, managing channels, and members

However the Discord integration will perform actions with the official Pipedream Discord bot.

Using the Discord Bot integration will use a custom bot instead, with it's own name and photo.

New Messages in Channel

Create this source here.

This event source emits events each time a new message is delivered to a Discord channel. By default, it emits an event for every message.

When you create this source, you'll be prompted to connect your Discord Bot token (press Connect Account and then New to add your token). The source will use that token to list the guilds / channels that bot has access to.

We use Discord's API to poll for new messages in this channel once a minute, by default, but you can increase this to run up to once every 15 seconds, if you'd like.

The first time this source runs, it fetches up to the last 100 messages sent to your channel and stores the ID of the last message delivered to that channel. The next time the source runs, it polls your channel for messages sent after that ID.

By default, this event source is configured to emit an event for every new message in the channel. For example, if 5 messages are sent to the channel in one minute, the source will emit 5 events, one for each message. You can set the source to batch the events the source collects and emit them as a single event by setting the Emit messages as a single event parameter to true.

Emit messages as a single event

In this example, the source would emit a single event: an array of 5 messages.

Message content is empty or missing

If you've successfully authenticated your Discord Bot to Pipedream, but the incoming message data including content, embeds and attachments are empty; then your bot needs to apply for access to this messaging data.

At the time of writing, Discord only requires bots in 100 or more servers to apply for this access.

You can request for this approval in the Discord Developer Portal.

Trigger Code

import maxBy from "lodash.maxby";
import common from "../common.mjs";

const { discord } = common.props;

export default {
  ...common,
  key: "discord_bot-new-message-in-channel",
  name: "New Message in Channel",
  description: "Emit new event for each message posted to one or more channels",
  type: "source",
  version: "0.0.5",
  dedupe: "unique", // Dedupe events based on the Discord message ID
  props: {
    ...common.props,
    db: "$.service.db",
    channels: {
      type: "string[]",
      label: "Channels",
      description: "The channels you'd like to watch for new messages",
      propDefinition: [
        discord,
        "channelId",
        ({ guildId }) => ({
          guildId,
        }),
      ],
    },
    emitEventsInBatch: {
      type: "boolean",
      label: "Emit messages as a single event",
      description:
        "If `true`, all messages are emitted as an array, within a single Pipedream event. Defaults to `false`, emitting each Discord message as its own event in Pipedream",
      optional: true,
      default: false,
    },
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: 60 * 15,
      },
    },
  },
  async run({ $ }) {
    // We store a cursor to the last message ID
    let lastMessageIDs = this._getLastMessageIDs();

    // If this is our first time running this source,
    // get the last N messages, emit them, and checkpoint
    for (const channelId of this.channels) {
      let lastMessageID;
      let messages = [];

      if (!lastMessageID) {
        messages = await this.discord.getMessages({
          $,
          channelId,
          params: {
            limit: 100,
          },
        });

        lastMessageID = messages.length
          ? maxBy(messages, (message) => message.id).id
          : 1;

      } else {
        let newMessages = [];

        do {
          newMessages = await this.discord.getMessages({
            $,
            channelId,
            params: {
              after: lastMessageIDs[channelId],
            },
          });

          messages = messages.concat(newMessages);

          lastMessageID = newMessages.length
            ? maxBy(newMessages, (message) => message.id).id
            : lastMessageIDs[channelId];

        } while (newMessages.length);
      }

      // Set the new high water mark for the last message ID
      // for this channel
      lastMessageIDs[channelId] = lastMessageID;

      if (!messages.length) {
        console.log(`No new messages in channel ${channelId}`);
        return;
      }

      console.log(`${messages.length} new messages in channel ${channelId}`);

      // Batched emits do not take advantage of the built-in deduper
      if (this.emitEventsInBatch) {
        const suffixChar =
          messages.length > 1
            ? "s"
            : "";

        this.$emit(messages, {
          summary: `${messages.length} new message${suffixChar}`,
          id: lastMessageID,
        });

      } else {
        messages.forEach((message) => {
          this.$emit(message, {
            summary: message.content,
            id: message.id, // dedupes events based on this ID
          });
        });
      }
    }

    // Set the last message ID for the next run
    this._setLastMessageIDs(lastMessageIDs);
  },
};

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
Discord BotdiscordappThis component uses the Discord Bot app.
GuildguildIdstringSelect a value from the drop down menu.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
Channelschannelsstring[]Select a value from the drop down menu.
Emit messages as a single eventemitEventsInBatchboolean

If true, all messages are emitted as an array, within a single Pipedream event. Defaults to false, emitting each Discord message as its own event in Pipedream

timer$.interface.timer

Trigger Authentication

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

This app allows you to use the Discord API using your own Discord bot. If you don't want to use a custom bot, and you just need to use the Discord API, exit this screen and use the Discord app, instead.


If you want to use your own Discord bot, but haven't created one yet, see these instructions or watch this video. You'll need to add this bot to your server(s) to make successful API requests.

Once you've created your bot, you'll find the Bot token within the Bot section of your app. Enter that token below.

About Discord Bot

Use this app to interact with the Discord API using a bot in your account

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 + Discord Bot

Create Record with Knack API on New Message in Channel from Discord Bot API
Discord Bot + Knack
 
Try it
Delete Record with Knack API on New Message in Channel from Discord Bot API
Discord Bot + Knack
 
Try it
Update Record with Knack API on New Message in Channel from Discord Bot API
Discord Bot + Knack
 
Try it
Add Role with Discord Bot API on New Record from Knack API
Knack + Discord Bot
 
Try it
Create Channel Invite with Discord Bot API on New Record from Knack API
Knack + Discord Bot
 
Try it
New Message in Channel from the Discord Bot API

Emit new event for each message posted to one or more channels

 
Try it
New Guild Member from the Discord Bot API

Emit new event for every member added to a guild

 
Try it
New Record from the Knack API

Emit new event for each record created

 
Try it
Add Role with the Discord Bot API

Assign a role to a user. Remember that your bot requires the MANAGE_ROLES permission. See the docs here

 
Try it
Create Channel Invite with the Discord Bot API

Create a new invite for the channel. See the docs here

 
Try it
Create DM with the Discord Bot API

Create a new DM channel with a user. See the docs here and here

 
Try it
Create Guild Channel with the Discord Bot API

Create a new channel for the guild. See the docs here

 
Try it
Delete Channel with the Discord Bot API

Delete a Channel.

 
Try it