Send Message with Discord API on Project Item Status Changed from GitHub API

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

Trigger workflow on

Project Item Status Changed from the GitHub API

Next, do this

Send Message 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 GitHub 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 Project Item Status Changed trigger
1. Connect your GitHub account
2. Select a Organization
3. Optional- Select a repo
4. Select a Project V2
5. Optional- Select one or more Item Status
6. Optional- Select one or more Filter Item Type
Configure the Send Message action
1. Connect your Discord account
2. Configure channel
3. 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
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#

Project Item Status Changed on GitHub

Description:Emit new event when a project item is tagged with a specific status. Currently supports Organization Projects only. [More information here](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project)

Version:0.1.6

Key:github-new-issue-with-status

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import queries from "../../common/queries.mjs";
import common from "../common/common-webhook-orgs.mjs";
import constants from "../common/constants.mjs";
import { getRelevantHeaders } from "../common/utils.mjs";

export default {
  ...common,
  key: "github-new-issue-with-status",
  name: "Project Item Status Changed",
  description: "Emit new event when a project item is tagged with a specific status. Currently supports Organization Projects only. [More information here](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project)",
  version: "0.1.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    repo: {
      ...common.props.repo,
      label: common.props.repo.label,
      description: common.props.repo.description,
      optional: true,
    },
    project: {
      propDefinition: [
        common.props.github,
        "projectV2",
        (c) => ({
          org: c.org,
          repo: c?.repo,
        }),
      ],
    },
    status: {
      propDefinition: [
        common.props.github,
        "status",
        (c) => ({
          org: c.org,
          repo: c?.repo,
          project: c.project,
        }),
      ],
      optional: true,
    },
    itemType: {
      type: "string[]",
      label: "Filter Item Type",
      description: "The item type(s) to emit events or. If not specified, events will be emitted for all item types.",
      optional: true,
      options: constants.PROJECT_ITEM_TYPES,
    },
  },
  methods: {
    ...common.methods,
    getWebhookEvents() {
      return [
        "projects_v2_item",
      ];
    },
    generateMeta(item, statusName) {
      const { id } = item;
      const ts = Date.parse(item.updated_at);
      return {
        id: `${id}-${ts}`,
        summary: `Item #${id} to status "${statusName}"`,
        ts,
      };
    },
    isRelevant(event) {
      const fieldChanged = event.changes?.field_value?.field_name;
      if (fieldChanged !== "Status") {
        return;
      }

      let isRelevant = true;
      let message = "";

      const statusId = event.changes.field_value.to.id;
      const itemType = event.projects_v2_item.content_type;

      if (this.status?.length && !this.status.includes(statusId)) {
        const statusName = event.changes.field_value.to.name;
        message = `Status "${statusName}". Skipping...`;
        isRelevant = false;
      } else if (this.itemType?.length && !this.itemType.includes(itemType)) {
        message = `Item type "${itemType}". Skipping...`;
        isRelevant = false;
      }

      if (message) console.log(message);
      return isRelevant;
    },
    async getProjectItem({ nodeId }) {
      const { node } = await this.github.graphql(queries.projectItemQuery, {
        nodeId,
      });
      return node;
    },
    async processEvent({
      event, headers,
    }) {
      const item = event.projects_v2_item;

      if (!this.isRelevant(event)) {
        return;
      }

      console.log(`Emitting item #${item.id}`);

      const statusName = event.changes.field_value.to.name;
      const meta = this.generateMeta(item, statusName);
      this.$emit({
        ...event,
        ...getRelevantHeaders(headers),
      }, meta);
    },
  },
  async run({
    body: event, headers,
  }) {
    if (event.zen) {
      console.log(event.zen);
      return;
    }

    await this.processEvent({
      event,
      headers,
    });
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Organization	`org`	`string`	Select a value from the drop down menu.
	`repo`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Project V2	`project`	`integer`	Select a value from the drop down menu.
Item Status	`status`	`string[]`	Select a value from the drop down menu.
Filter Item Type	`itemType`	`string[]`	Select a value from the drop down menu:`IssuePullRequestDraftIssue`

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_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

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#

Send Message on Discord

Description:Send a simple message to a Discord channel

Version:1.0.2

Key:discord-send-message

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";

export default {
  ...common,
  key: "discord-send-message",
  name: "Send Message",
  description: "Send a simple message to a Discord channel",
  version: "1.0.2",
  type: "action",
  async run({ $ }) {
    const {
      message,
      avatarURL,
      threadID,
      username,
      includeSentViaPipedream,
      suppressNotifications,
    } = this;
    try {
      const resp = await this.discord.sendMessage(this.channel, {
        avatar_url: avatarURL,
        username,
        flags: this.getMessageFlags(suppressNotifications),
        content: includeSentViaPipedream
          ? this.appendPipedreamText(message)
          : message,
      }, {
        thread_id: threadID,
      });
      $.export("$summary", "Message sent successfully");
      return resp || {
        success: true,
      };
    } catch (err) {
      console.log(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.

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

Send Message with Discord API on Project Item Status Changed from GitHub API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular