← GitHub + Discord Webhook integrations

Send Message with Discord Webhook APIon New Commit from GitHub API

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

Trigger workflow on
New Commit from the GitHub API
Next, do this
Send Message with the Discord Webhook 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 GitHub trigger and Discord Webhook 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 Commit trigger
    1. Connect your GitHub account
    2. Configure timer
    3. Select a Repo
    4. Optional- Select a Branch
  3. Configure the Send Message action
    1. Connect your Discord Webhook account
    2. Configure Message
    3. Optional- Configure Thread ID
    4. Optional- Configure Username
    5. Optional- Configure Avatar URL
    6. Optional- Configure Include link to workflow
  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 events on new commits to a repo or branch
Version:0.0.5
Key:github-new-commit

Trigger Code

const github = require("../../github.app.js");
const common = require("../common-polling.js");

module.exports = {
  ...common,
  key: "github-new-commit",
  name: "New Commit",
  description: "Emit new events on new commits to a repo or branch",
  version: "0.0.5",
  type: "source",
  props: {
    ...common.props,
    repoFullName: {
      propDefinition: [
        github,
        "repoFullName",
      ],
    },
    branch: {
      propDefinition: [
        github,
        "branch",
        (c) => ({
          repoFullName: c.repoFullName,
        }),
      ],
      description:
        "Branch to monitor for new commits. If no branch is selected, the repository’s default branch will be used (usually master).",
    },
  },
  dedupe: "last",
  methods: {
    generateMeta(data) {
      const ts = new Date(data.commit.author.date).getTime();
      return {
        id: data.sha,
        summary: data.commit.message,
        ts,
      };
    },
  },
  async run() {
    const since = this.db.get("since");
    const firstRun = this.db.get("firstRun") ?? true;

    const config = {
      repoFullName: this.repoFullName,
      sha: this.branch,
      since,
    };
    const commits = await this.github.getCommits(config);
    const commitsToEmit = firstRun
      ? commits.slice(0, 10)
      : commits;

    let maxDate = since;
    for (const commit of commitsToEmit) {
      if (!maxDate || new Date(commit.commit.author.date) > new Date(maxDate)) {
        maxDate = commit.commit.author.date;
      }
      const meta = this.generateMeta(commit);
      this.$emit(commit, meta);
    }

    if (maxDate !== since) {
      this.db.set("since", maxDate);
    }

    if (firstRun) {
      this.db.set("firstRun", false);
    }
  },
};

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
GitHubgithubappThis component uses the GitHub app.
timer$.interface.timer
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
ReporepoFullNamestringSelect a value from the drop down menu.
BranchbranchstringSelect a value from the drop down menu.

Trigger Authentication

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

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

repoadmin:orgadmin:public_keyadmin:org_hookgistnotificationsuserwrite:discussionwrite:packagesread:packages

About GitHub

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action

Description:Send a simple message to a Discord channel
Version:0.3.0
Key:discord_webhook-send-message

Action Code

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

export default {
  ...common,
  key: "discord_webhook-send-message",
  name: "Send Message",
  description: "Send a simple message to a Discord channel",
  version: "0.3.0",
  type: "action",
  props: {
    ...common.props,
  },
  async run({ $ }) {
    const {
      message,
      avatarURL,
      threadID,
      username,
      includeSentViaPipedream,
    } = this;

    try {
      // No interesting data is returned from Discord
      await this.discordWebhook.sendMessage({
        avatarURL,
        threadID,
        username,
        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.

LabelPropTypeDescription
Discord WebhookdiscordWebhookappThis component uses the Discord Webhook app.
Messagemessagestring

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 IDthreadIDstring

If provided, the message will be posted to this thread

Usernameusernamestring

Overrides the current username of the webhook

Avatar URLavatarURLstring

If used, it overrides the default avatar of the webhook

Include link to workflowincludeSentViaPipedreamboolean

Defaults to true, includes a link to this workflow at the end of your Discord message.

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

About Discord Webhook

Use this app to send messages to a channel using Discord's incoming webhooks

More Ways to Connect Discord Webhook + GitHub