discord_notifications.md 1.75 KB
Newer Older
1 2 3
---
stage: Create
group: Ecosystem
4
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
5 6
---

7
# Discord Notifications service **(FREE)**
blackst0ne's avatar
blackst0ne committed
8

9
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22684) in GitLab 11.6.
blackst0ne's avatar
blackst0ne committed
10

blackst0ne's avatar
blackst0ne committed
11
The Discord Notifications service sends event notifications from GitLab to the channel for which the webhook was created.
blackst0ne's avatar
blackst0ne committed
12

blackst0ne's avatar
blackst0ne committed
13
To send GitLab event notifications to a Discord channel, create a webhook in Discord and configure it in GitLab.
14

blackst0ne's avatar
blackst0ne committed
15
## Create webhook
blackst0ne's avatar
blackst0ne committed
16

blackst0ne's avatar
blackst0ne committed
17
1. Open the Discord channel you want to receive GitLab event notifications.
blackst0ne's avatar
blackst0ne committed
18 19
1. From the channel menu, select **Edit channel**.
1. Click on **Webhooks** menu item.
20
1. Click the **Create Webhook** button and fill in the name of the bot to post the messages. Optionally, edit the avatar.
blackst0ne's avatar
blackst0ne committed
21 22
1. Note the URL from the **WEBHOOK URL** field.
1. Click the **Save** button.
blackst0ne's avatar
blackst0ne committed
23

blackst0ne's avatar
blackst0ne committed
24
## Configure created webhook in GitLab
blackst0ne's avatar
blackst0ne committed
25

blackst0ne's avatar
blackst0ne committed
26
With the webhook URL created in the Discord channel, you can set up the Discord Notifications service in GitLab.
blackst0ne's avatar
blackst0ne committed
27

28 29
1. Navigate to the [Integrations page](overview.md#accessing-integrations) in your project's settings. That is, **Project > Settings > Integrations**.
1. Select the **Discord Notifications** integration to configure it.
30
1. Ensure that the **Active** toggle is enabled.
31
1. Check the checkboxes corresponding to the GitLab events for which you want to send notifications to Discord.
blackst0ne's avatar
blackst0ne committed
32 33
1. Paste the webhook URL that you copied from the create Discord webhook step.
1. Configure the remaining options and click the **Save changes** button.
blackst0ne's avatar
blackst0ne committed
34

35
The Discord channel you created the webhook for now receives notification of the GitLab events that were configured.