Send message with Discord Bot API on New Merge Request (Instant) from GitLab API

Pipedream makes it easy to connect APIs for Discord Bot, GitLab and 2,900+ other apps remarkably fast.

Trigger workflow on

New Merge Request (Instant) from the GitLab API

Next, do this

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

Select this integration
Configure the New Merge Request (Instant) trigger
1. Connect your GitLab account
2. Select a Project ID
Configure the Send message action
1. Connect your Discord Bot account
2. Select a Guild
3. Configure Message
4. Optional- Configure Embeds
5. Optional- Configure Thread ID
6. Optional- Configure Username
7. Optional- Configure Avatar URL
8. Optional- Configure Include link to workflow
9. Optional- Select a User
10. Optional- Select a Channel
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 Merge Request (Instant) on GitLab

Description:Emit new event when a merge request is created

Version:0.1.2

Key:gitlab-new-merge-request

View on GitHub

GitLab Overview#

The GitLab API provides programmatic access to your GitLab projects, allowing you to automate common tasks, manage issues, merge requests, and more. With the GitLab API on Pipedream, you can create customized workflows that integrate with other services, streamline your development process, and enhance project management. By leveraging the power of serverless, you can set up triggers for GitLab events and perform actions across a variety of apps without managing infrastructure.

Trigger Code#

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

export default {
  ...base,
  key: "gitlab-new-merge-request",
  name: "New Merge Request (Instant)",
  description: "Emit new event when a merge request is created",
  version: "0.1.2",
  dedupe: "unique",
  type: "source",
  hooks: {
    ...base.hooks,
    async activate() {
      await this.activateHook(eventTypes.MERGE_REQUESTS_EVENTS);
    },
  },
  methods: {
    ...base.methods,
    isNewMergeRequest(event) {
      const action = event?.object_attributes?.action;
      const expectedAction = "open";
      return action === expectedAction;
    },
    generateMeta({
      user, mergeRequest,
    }) {
      const {
        name,
        username,
      } = user;
      const {
        id,
        created_at: createdAt,
        title,
      } = mergeRequest;
      return {
        id,
        summary: `New Merge Request: "${title}" by ${name} (${username})`,
        ts: +new Date(createdAt),
      };
    },
    async emitEvent(event) {
      // Gitlab doesn't offer a specific hook for "new merge request" events,
      // but such event can be deduced from the payload of "merge request" events.
      if (this.isNewMergeRequest(event)) {
        const meta = this.generateMeta({
          user: event.user,
          mergeRequest: 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.

Label	Prop	Type	Description
GitLab	`gitlab`	`app`	This component uses the GitLab app.
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 ID	`projectId`	`integer`	Select 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#

GitLab is the most comprehensive AI-powered DevSecOps Platform.

Action#

Send message on Discord Bot

Description:Send message to a user or a channel. [See the docs here](https://discord.com/developers/docs/resources/user#create-dm) and [here](https://discord.com/developers/docs/resources/channel#create-message)

Version:1.0.1

Key:discord_bot-send-message

View on GitHub

Discord Bot Overview#

The Discord Bot API unlocks the power to interact with Discord users and channels programmatically, making it possible to automate messages, manage servers, and integrate with other services. With Pipedream's serverless platform, you can create complex workflows that respond to events in Discord, process data, and trigger actions in other apps. This opens up opportunities for community engagement, content moderation, analytics, and more, without the overhead of managing infrastructure.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import common from "../../common.mjs";
import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";

const { discord } = common.props;

export default {
  key: "discord_bot-send-message",
  name: "Send message",
  description: "Send message to a user or a channel. [See the docs here](https://discord.com/developers/docs/resources/user#create-dm) and [here](https://discord.com/developers/docs/resources/channel#create-message)",
  version: "1.0.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    discord,
    ...common.props,
    message: {
      propDefinition: [
        discord,
        "message",
      ],
    },
    embeds: {
      propDefinition: [
        discord,
        "embeds",
      ],
    },
    threadID: {
      propDefinition: [
        discord,
        "threadID",
      ],
    },
    username: {
      propDefinition: [
        discord,
        "username",
      ],
    },
    avatarURL: {
      propDefinition: [
        discord,
        "avatarURL",
      ],
    },
    includeSentViaPipedream: {
      type: "boolean",
      optional: true,
      default: true,
      label: "Include link to workflow",
      description: "Defaults to `true`, includes a link to this workflow at the end of your Discord message.",
    },
    userId: {
      propDefinition: [
        discord,
        "userId",
        (c) => ({
          guildId: c.guildId,
        }),
      ],
      description: "Select either a user or a channel",
      optional: true,
    },
    channelId: {
      propDefinition: [
        discord,
        "channelId",
        ({ guildId }) => ({
          guildId,
          notAllowedChannels: constants.NOT_ALLOWED_CHANNELS,
        }),
      ],
      description: "Select either a channel or an user",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getUserInputProps(omit = [
      "discord",
    ]) {
      return Object.keys(this)
        .filter((key) => typeof this[key] !== "function" && !omit.includes(key))
        .reduce((props, key) => {
          props[key] = this[key];
          return props;
        }, {});
    },
    appendPipedreamText(message) {
      let content = message;
      if (typeof content !== "string") {
        content = JSON.stringify(content);
      }
      content += `\n\n${this.getSentViaPipedreamText()}`;
      return content;
    },
    getSentViaPipedreamText() {
      const workflowId = process.env.PIPEDREAM_WORKFLOW_ID;
      // The link text is a URL without a protocol for consistency with the "Send via link" text in
      // Slack messages
      const linkText = `pipedream.com/@/${workflowId}?o=a&a=discord_webhook`;
      const link = `https://${linkText}`;
      return `Sent via [${linkText}](<${link}>)`;
    },
  },
  async run({ $ }) {
    if ((this.userId && this.channelId) || (!this.userId && !this.channelId)) {
      throw new ConfigurationError("You must select either a user or a channel.");
    }
    let channelId = this.channelId;
    if (this.userId) {
      const createDMChannelResponse = await this.discord.createDm({
        $,
        recipientId: this.userId,
      });
      channelId = createDMChannelResponse.id;
    }
    if (channelId) {
      const createMessageResponse = await this.discord.createMessage({
        $,
        channelId,
        data: {
          embeds: utils.parseObject(this.embeds),
          avatarURL: this.avatarURL,
          threadID: this.threadID,
          username: this.username,
          content: this.includeSentViaPipedream
            ? this.appendPipedreamText(this.message)
            : this.message,
        },
      });
      $.export("$summary", "Message has been sent successfully");
      return createMessageResponse;
    } else {
      $.export("$summary", "Could not create or retrieve DM channel!");
      throw new Error("Create DM Channel call was not successful!");
    }
  },
};

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 Bot	`discord`	`app`	This component uses the Discord Bot app.
Guild	`guildId`	`string`	Select a value from the drop down menu.
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.
Embeds	`embeds`	`any`	Embedded rich content (up to 6000 characters), this should be given as an array, e.g. `[{"title": "Hello, Embed!","description": "This is an embedded message."}]`. 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.
Thread ID	`threadID`	`string`	If provided, the message will be posted to this thread
Username	`username`	`string`	Overrides the current username
Avatar URL	`avatarURL`	`string`	If used, it overrides the default avatar
Include link to workflow	`includeSentViaPipedream`	`boolean`	Defaults to `true`, includes a link to this workflow at the end of your Discord message.
User	`userId`	`string`	Select a value from the drop down menu.
Channel	`channelId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

This app allows you to use the Discord API using your own Discord bot. If you don't want to use a custom bot, and you just need to use the Discord API, exit this screen and use the Discord app, instead.

If you want to use your own Discord bot, but haven't created one yet, see these instructions or watch this video. You'll need to add this bot to your server(s) to make successful API requests.

Once you've created your bot, you'll find the Bot token within the Bot section of your app. Enter that token below.

Send message with Discord Bot API on New Merge Request (Instant) from GitLab API

Pipedream makes it easy to connect APIs for Discord Bot, GitLab and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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