← Gitlab + Discord Webhook integrations

Send Message with Discord Webhook API on New Commit Comment (Instant) from Gitlab API

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

Trigger workflow on
New Commit Comment (Instant) from the Gitlab 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 Gitlab 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 Comment (Instant) trigger
    1. Connect your Gitlab account
    2. Select a Project ID
  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 event when a commit receives a comment
Version:0.1.0
Key:gitlab-new-commit-comment

Gitlab Overview

Gitlab API allows developers to access the functionality of Gitlab. With the
Gitlab API, developers can integrate Gitlab with other applications, create
custom applications, or automate tasks.

Some examples of what you can build using the Gitlab API include:

  • Automate tasks such as creating and managing repositories
  • Integrate Gitlab with other applications such as your chat application
  • Create custom applications on top of Gitlab

Trigger Code

import base from "../common/base.mjs";
import { eventTypes } from "../common/hook-events.mjs";

export default {
  ...base,
  key: "gitlab-new-commit-comment",
  name: "New Commit Comment (Instant)",
  description: "Emit new event when a commit receives a comment",
  version: "0.1.0",
  dedupe: "unique",
  type: "source",
  hooks: {
    ...base.hooks,
    async activate() {
      await this.activateHook(eventTypes.NOTE_EVENTS);
    },
  },
  methods: {
    ...base.methods,
    isCommentOnCommit(commit) {
      const noteableType = commit.object_attributes?.noteable_type;
      const expectedNoteableType = "Commit";
      return noteableType === expectedNoteableType;
    },
    generateMeta({
      user, comment,
    }) {
      const {
        name,
        username,
      } = user;
      const {
        id,
        created_at: createdAt,
        commit_id: commitId,
      } = comment;
      return {
        id,
        summary: `New comment by ${name} (${username}) on commit ${commitId}`,
        ts: +new Date(createdAt),
      };
    },
    async emitEvent(event) {
      // Gitlab doesn't offer a specific hook for "commit comments" events,
      // but such event can be deduced from the payload of "note" events.
      if (this.isCommentOnCommit(event)) {
        const meta = this.generateMeta({
          user: event.user,
          comment: event.object_attributes,
        });
        this.$emit(event, 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
GitlabgitlabappThis component uses the Gitlab app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
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.
Project IDprojectIdintegerSelect a value from the drop down menu.

Trigger Authentication

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

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

apiread_userread_repositorywrite_repositoryread_registrysudoopenidprofileemail

About Gitlab

Project planning and source code management

Action

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

Discord Webhook Overview

With Discord's Webhook API, you can create applications that send messages to
Discord channels automatically. For example, you could create a bot that sends
a message to a channel every time a new blog post is published, or a message to
a channel when someone joins your Discord server.

Here are some ideas for what you could build using the Discord Webhook API:

  • A bot that sends a message to a channel when a new blog post is published
  • A bot that sends a message to a channel when someone joins your Discord
    server
  • A bot that sends a message to a channel when a new product is added to your
    online store

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.1",
  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. Note: Consecutive posts by the same username within 10 minutes of each other will not display updated avatar.

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 + Gitlab

Send Message (Advanced) with Discord Webhook API on New Review Request (Instant) from Gitlab API
Gitlab + Discord Webhook
 
Try it
Send Message with Discord Webhook API on New Review Request (Instant) from Gitlab API
Gitlab + Discord Webhook
 
Try it
Send Message (Advanced) with Discord Webhook API on New Milestone from Gitlab API
Gitlab + Discord Webhook
 
Try it
Send Message with Discord Webhook API on New Milestone from Gitlab API
Gitlab + Discord Webhook
 
Try it
Send Message (Advanced) with Discord Webhook API on New Project from Gitlab API
Gitlab + Discord Webhook
 
Try it
New Commit (Instant) from the Gitlab API

Emit new event when a new commit is pushed to a branch

 
Try it
New Branch (Instant) from the Gitlab API

Emit new event when a new branch is created

 
Try it
New Project from the Gitlab API

Emit new event when a project (i.e. repository) is created

 
Try it
New Audit Event (Instant) from the Gitlab API

Emit new event when a new audit event is created

 
Try it
New Commit Comment (Instant) from the Gitlab API

Emit new event when a commit receives a comment

 
Try it
Create Branch with the Gitlab API

Create a new branch in the repository. See docs

 
Try it
Create Epic with the Gitlab API

Creates a new epic. See docs

 
Try it
Create issue with the Gitlab API

Creates a new issue. See docs

 
Try it
Edit Issue with the Gitlab API

Updates an existing project issue. See docs

 
Try it
Get Issue with the Gitlab API

Gets a single issue from repository. See docs

 
Try it