Send Message With File with Discord API on New Deploy Complete from DeployHQ API

Pipedream makes it easy to connect APIs for Discord, DeployHQ and 2,400+ other apps remarkably fast.

Trigger workflow on

New Deploy Complete from the DeployHQ API

Next, do this

Send Message With File with the Discord 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 DeployHQ trigger and Discord action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Deploy Complete trigger
1. Connect your DeployHQ account
Configure the Send Message With File action
1. Connect your Discord account
2. Configure channel
3. Optional- Configure Message
4. Optional- Configure Thread ID
5. Optional- Configure Username
6. Optional- Configure Avatar URL
7. Optional- Configure Include link to workflow
8. Optional- Configure Suppress notifications
9. Optional- Configure File URL
10. 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, 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 Deploy Complete on DeployHQ

Description:Emit new event when a deploy is completed

Version:0.0.2

Key:deployhq-deploy-complete

View on GitHub

DeployHQ Overview#

DeployHQ is a service that automates the deployment of your web applications. By integrating with version control systems, DeployHQ can automatically deploy code changes to various environments. Using the DeployHQ API on Pipedream, you can orchestrate deployments, manage your projects, and synchronize deployment activities with other tools in your toolchain. It opens up possibilities for custom deployment workflows, notifications, monitoring, and more, all connected within the Pipedream ecosystem.

Trigger Code#

import common, { STATUS_COMPLETE } from "../common.mjs";

export default {
  ...common,
  key: "deployhq-deploy-complete",
  name: "New Deploy Complete",
  version: "0.0.2",
  description: "Emit new event when a deploy is completed",
  type: "source",
  async run(request) {
    const { payload } = this.validateRequest(request);

    if (payload.status !== STATUS_COMPLETE) {
      console.log(`Deploy status [${payload.status}] is not ${STATUS_COMPLETE}`);
      return;
    }

    this.$emit({
      payload,
    }, {
      id: payload.identifier,
      summary: `Completed ${payload.identifier}`,
      ts: Date.now(),
    });
  },
};

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
DeployHQ	`deployHq`	`app`	This component uses the DeployHQ app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger Authentication#

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

DeployHQ requires their users enter their email, API Key, and account name in order to connect to their API. For more info, refer to DeployHQ’s documentation.

To retrieve your API key,

Navigate to your DeployHQ account and sign in
Go to “Settings” > “Security”

Your account name is 1234 if your DeployHQ URL is https://1234.deployhq.com

About DeployHQ#

Deployment made simple. We make it super easy to automate deploying projects from Git, SVN and Mercurial repositories.

Action#

Send Message With File on Discord

Description:Post a message with an attached file

Version:1.1.1

Key:discord-send-message-with-file

View on GitHub

Discord Overview#

The Discord API interacts seamlessly with Pipedream, empowering you to craft customized automations and workflows for your Discord server. With this powerful integration, you can automate tasks like message posting, user management, and notifications, based on a myriad of triggers and actions from different apps. These automations can enhance the Discord experience for community moderators and members, by synchronizing with external tools, organizing community engagement, and streamlining notifications.

Action Code#

import common from "../common/common.mjs";
import { axios } from "@pipedream/platform";
import fs from "fs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...common,
  key: "discord-send-message-with-file",
  name: "Send Message With File",
  description: "Post a message with an attached file",
  version: "1.1.1",
  type: "action",
  props: {
    ...common.props,
    message: {
      propDefinition: [
        common.props.discord,
        "message",
      ],
      optional: true,
    },
    fileUrl: {
      propDefinition: [
        common.props.discord,
        "fileUrl",
      ],
    },
    filePath: {
      propDefinition: [
        common.props.discord,
        "filePath",
      ],
    },
  },
  async run({ $ }) {
    const {
      message,
      avatarURL,
      threadID,
      username,
      fileUrl,
      filePath,
      includeSentViaPipedream,
      suppressNotifications,
    } = this;

    if (!fileUrl && !filePath) {
      throw new ConfigurationError("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",
      })
      : fs.createReadStream(filePath);

    try {
      const resp = await this.discord.sendMessage(this.channel, {
        avatar_url: avatarURL,
        username,
        file,
        flags: this.getMessageFlags(suppressNotifications),
        content: includeSentViaPipedream
          ? this.appendPipedreamText(message ?? "")
          : message,
      }, {
        thread_id: threadID,
      });
      $.export("$summary", "Message sent successfully");
      return resp || {
        success: true,
      };
    } 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	`discord`	`app`	This component uses the Discord app.
channel	`channel`	`$.discord.channel`
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. Note: Consecutive posts by the same username within 10 minutes of each other will not display updated avatar.
Include link to workflow	`includeSentViaPipedream`	`boolean`	Defaults to `true`, includes a link to this workflow at the end of your Discord message.
Suppress notifications	`suppressNotifications`	`boolean`	Defaults to `false`, sends the message as silent, triggers no notifications to clients.
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 uses OAuth authentication. When you connect your Discord account, Pipedream will open a popup window where you can sign into Discord 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 API.

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

botemailidentifyguilds