← GitHub + Discord Webhook integrations

Send Message (Advanced) with Discord Webhook APIon Custom Webhook Events from GitHub API

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

Trigger workflow on
Custom Webhook Events from the GitHub API
Next, do this
Send Message (Advanced) 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 Custom Webhook Events trigger
    1. Connect your GitHub account
    2. Select a Repo
    3. Select one or more Events
  3. Configure the Send Message (Advanced) 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 Embeds
  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 of selected types
Version:0.0.7
Key:github-custom-events

Trigger Code

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

module.exports = {
  ...common,
  key: "github-custom-events",
  name: "Custom Webhook Events",
  description:
    "Emit new events of selected types",
  type: "source",
  version: "0.0.7",
  props: {
    ...common.props,
    events: {
      propDefinition: [
        github,
        "events",
      ],
    },
  },
  dedupe: "unique",
  methods: {
    getEventNames() {
      return this.events;
    },
    generateMeta(data, id) {
      const ts = Date.now();
      return {
        id,
        summary: `${data.action} event by ${data.sender.login}`,
        ts,
      };
    },
    emitEvent(body, id) {
      const meta = this.generateMeta(body, id);
      this.$emit(body, meta);
    },
  },
};

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.
ReporepoFullNamestringSelect a value from the drop down menu.
N/Ahttp$.interface.httpThis 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.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
Eventseventsstring[]Select a value from the drop down menu:check_runcheck_suitecode_scanning_alertcommit_commentcontent_referencecreatedeletedeploy_keydeploymentdeployment_statusdiscussiondiscussion_commentforkgithub_app_authorizationgolluminstallationinstallation_repositoriesissue_commentissueslabelmarketplace_purchasemembermembershipmetamilestoneorganizationorg_blockpackagepage_buildpingproject_cardproject_columnprojectpublicpull_requestpull_request_reviewpull_request_review_commentpushreleaserepository_dispatchrepositoryrepository_importrepository_vulnerability_alertsecret_scanning_alertsecurity_advisorysponsorshipstarstatusteamteam_addwatchworkflow_dispatchworkflow_run

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 or structured message (using embeds) to a Discord channel
Version:0.3.0
Key:discord_webhook-send-message-advanced

Action Code

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

export default {
  ...common,
  key: "discord_webhook-send-message-advanced",
  name: "Send Message (Advanced)",
  description: "Send a simple or structured message (using embeds) to a Discord channel",
  version: "0.3.0",
  type: "action",
  props: {
    ...common.props,
    message: {
      propDefinition: [
        common.props.discordWebhook,
        "message",
      ],
      optional: true,
    },
    embeds: {
      propDefinition: [
        common.props.discordWebhook,
        "embeds",
      ],
    },
  },
  async run({ $ }) {
    const {
      message,
      avatarURL,
      threadID,
      username,
      includeSentViaPipedream,
      embeds,
    } = this;

    if (!message && !embeds) {
      throw new Error("This action requires at least 1 message OR embeds object. Please enter one or the other above.");
    }

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

Embedsembedsany

Optionally pass an array of embed objects. E.g., {{ [{"description":"Use markdown including *Italic* **bold** __underline__ ~~strikeout~~ [hyperlink](https://google.com) `code`"}] }}. To pass data from another step, enter a reference using double curly brackets (e.g., {{steps.mydata.$return_value}}).
Tip: Construct the embeds array in a Node.js code step, return it, and then pass the return value to this step.

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