Send Message With File with Discord Webhook API on New Records from SQL Query from Pipedream API

Pipedream makes it easy to connect APIs for Discord Webhook, Pipedream and 800+ other apps remarkably fast.

Trigger workflow on

New Records from SQL Query from the Pipedream API

Next, do this

Send Message With File with the Discord Webhook API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Records from SQL Query trigger
1. Configure timer
2. Configure SQL Query
3. Optional- Select a Result Type
4. Optional- Configure Emit each record as its own event
5. Connect your Pipedream account
Configure the Send Message With File action
1. Connect your Discord Webhook account
2. Optional- Configure Message
3. Optional- Configure Thread ID
4. Optional- Configure Username
5. Optional- Configure Avatar URL
6. Optional- Configure Include link to workflow
7. Optional- Configure File URL
8. Optional- Configure File Path
Deploy the workflow
Send a test event to validate your setup
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#

New Records from SQL Query on Pipedream

Description:Runs a query against the Pipedream SQL Service on a schedule, emitting the results in batch (default) or with each record as its own event

Version:0.0.2

Key:pipedream-new-records-from-sql-query

View on GitHub

Trigger Code#

const pipedream = require("../../pipedream.app.js");

module.exports = {
  key: "pipedream-new-records-from-sql-query",
  name: "New Records from SQL Query",
  description:
    "Runs a query against the Pipedream SQL Service on a schedule, emitting the results in batch (default) or with each record as its own event",
  version: "0.0.2",
  dedupe: "unique", // Dedupes records based on the query execution ID
  props: {
    timer: {
      type: "$.interface.timer",
      default: {
        cron: "0 0 * * *",
      },
    },
    sqlQuery: {
      type: "string",
      label: "SQL Query",
      description:
        "Your SQL query (try running in [https://pipedream.com/sql](https://pipedream.com/sql) first)",
    },
    resultType: {
      type: "string",
      label: "Result Type",
      description: `Specifies how you want the query results formatted`,
      optional: true,
      options: ["array", "object", "csv"],
      default: "array",
    },
    emitEachRecordAsEvent: {
      type: "boolean",
      label: "Emit each record as its own event",
      description:
        "If `true`, each record in your results set is emitted as its own event. Defaults to emitting results as a single event (an array of records)",
      optional: true,
      default: false,
    },
    pipedream,
  },
  async run() {
    const results = await this.pipedream.runSQLQuery(
      this.sqlQuery,
      this.resultType
    );
    if (this.resultType === "array" && this.emitEachRecordAsEvent) {
      // First, extract the properties to include in every event
      const { columnInfo, queryExecutionId, csvLocation } = results;
      let event = {
        columnInfo,
        queryExecutionId,
        csvLocation,
      };
      const header = results.results.shift();
      for (const [i, row] of results.results.entries()) {
        let record = {};
        for (const [j, col] of header.entries()) {
          record[col] = row[j];
        }
        // For each record, emit an event
        this.$emit(
          {
            query: this.sqlQuery,
            results: {
              columnInfo,
              queryExecutionId,
              csvLocation,
              record,
            },
          },
          {
            summary: `${this.sqlQuery} - ${i}`,
            id: `${results.queryExecutionId}-${i}`,
          }
        );
      }
      return;
    }
    this.$emit(
      { query: this.sqlQuery, results },
      {
        summary: this.sqlQuery,
        id: results.queryExecutionId,
      }
    );
  },
};

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
	`timer`	`$.interface.timer`
SQL Query	`sqlQuery`	`string`	Your SQL query (try running in https://pipedream.com/sql first)
Result Type	`resultType`	`string`	Select a value from the drop down menu:`arrayobjectcsv`
Emit each record as its own event	`emitEachRecordAsEvent`	`boolean`	If `true`, each record in your results set is emitted as its own event. Defaults to emitting results as a single event (an array of records)
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.

Trigger Authentication#

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

Enter the API key from your Pipedream Account Settings

About Pipedream#

Integration platform for developers

Action#

Send Message With File on Discord Webhook

Description:Post a message with an attached file

Version:0.2.0

Key:discord_webhook-send-message-with-file

View on GitHub

Action Code#

import common from "../send-message-common.mjs";
import axios from "axios";
import fs from "fs";

export default {
  ...common,
  key: "discord_webhook-send-message-with-file",
  name: "Send Message With File",
  description: "Post a message with an attached file",
  version: "0.2.0",
  type: "action",
  props: {
    ...common.props,
    message: {
      propDefinition: [
        common.props.discordWebhook,
        "message",
      ],
      optional: true,
    },
    fileUrl: {
      type: "string",
      label: "File URL",
      description:
        "The URL of the file to attach. Must specify either **File URL** or **File Path**.",
      optional: true,
    },
    filePath: {
      type: "string",
      label: "File Path",
      description:
        "The path to the file, e.g. `/tmp/myFile.csv`. Must specify either **File URL** or **File Path**.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      message,
      avatarURL,
      threadID,
      username,
      fileUrl,
      filePath,
      includeSentViaPipedream,
    } = this;

    if (!fileUrl && !filePath) {
      throw new Error("This action requires either File URL or File Path. Please enter one or the other above.");
    }

    const file = fileUrl
      ? (await axios({
        method: "get",
        url: fileUrl,
        responseType: "stream",
      })).data
      : fs.createReadStream(filePath);

    try {
      // No interesting data is returned from Discord
      await this.discordWebhook.sendMessageWithFile({
        avatarURL,
        threadID,
        username,
        file,
        content: includeSentViaPipedream
          ? this.appendPipedreamText(message ?? "")
          : message,
      });
      $.export("$summary", "Message sent successfully");
    } catch (err) {
      const unsentMessage = this.getUserInputProps();
      $.export("unsent", unsentMessage);
      throw err;
    }
  },
};

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
Discord Webhook	`discordWebhook`	`app`	This component uses the Discord Webhook app.
Message	`message`	`string`	Enter a simple message up to 2000 characters. This is the most commonly used field. However, it's optional if you pass embed content.
Thread ID	`threadID`	`string`	If provided, the message will be posted to this thread
Username	`username`	`string`	Overrides the current username of the webhook
Avatar URL	`avatarURL`	`string`	If used, it overrides the default avatar of the webhook
Include link to workflow	`includeSentViaPipedream`	`boolean`	Defaults to `true`, includes a link to this workflow at the end of your Discord message.
File URL	`fileUrl`	`string`	The URL of the file to attach. Must specify either File URL or File Path.
File Path	`filePath`	`string`	The path to the file, e.g. `/tmp/myFile.csv`. Must specify either File URL or File Path.

Action Authentication#

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

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

webhook.incomingemailidentify