Skip to content

Commit 6948361

Browse files
spalmurraygetsantry[bot]
authored andcommitted
Add Discord integration docs (#7645)
* Add Discord to integration index * Remove random asterisk from slack docs. idk why this was there * Add Discord product docs * style(lint): Auto commit lint changes * Fix Discord links * Make a couple images wider * Move Discord out of integrations and into EA features * Make requested changes * Move discord docs to ea features directory * Change title to Discord Integration --------- Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
1 parent a1f5912 commit 6948361

File tree

11 files changed

+86
-1
lines changed

11 files changed

+86
-1
lines changed
97.8 KB
Loading
377 KB
Loading
307 KB
Loading
105 KB
Loading
149 KB
Loading
57.9 KB
Loading
80 KB
Loading
331 KB
Loading
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: Discord Integration
3+
sidebar_order: 1
4+
description: "Learn more about Sentry's Discord integration and how you can get notified and manage issues right in Discord."
5+
---
6+
7+
<Include name="feature-available-for-user-group-early-adopter.mdx" />
8+
9+
Get notified and manage issues right in Discord with Sentry's Discord integration.
10+
11+
## Install
12+
13+
<Note>
14+
15+
Sentry owner, manager, or admin permissions are required to install this integration.
16+
17+
</Note>
18+
19+
1. In [sentry.io](https://sentry.io), nagivate to **Settings > Integrations > Discord**.
20+
21+
1. Click "Add Installation". A pop up window should open.
22+
23+
![Install Discord integration](discord-integration-details.png)
24+
25+
1. Log in to your Discord account. If you're already logged in, this login step will not be displayed.
26+
27+
1. Use the dropdown menu to select the Discord server you'd like to add Sentry to and click "Continue".
28+
29+
<Note>
30+
You will need to have the "Manage Server" permission enabled for your
31+
Discord account in the server you're trying to add the bot to.
32+
</Note>
33+
34+
![Select server](discord-server-select.png)
35+
36+
1. Finally, once the server is selected, click "Authorize". The integration will be created and the Sentry Discord bot will join the selected server.
37+
38+
Your Discord integration is now available to all projects in your Sentry organization.
39+
40+
In the next section, we'll walk through configuring Discord notifications.
41+
42+
## Configure
43+
44+
Currently our Discord integration supports issue alert rules, with metric alerts and personal notifications planned for future updates to the integration.
45+
46+
### Issue Alerts
47+
48+
Follow the steps below to create a new issue alert that sends Discord notifications.
49+
50+
1. In Sentry, go to **Alerts** and click "Create Alert".
51+
52+
1. Select "Issues" and then click "Set Conditions".
53+
54+
![Create issue alert](discord-add-issue-alert.png)
55+
56+
1. Configure your issue alert conditions as desired.
57+
58+
1. To set up Discord notifications, select "Send a Discord notification" in the "THEN" actions dropdown.
59+
60+
1. Select the Discord server and channel you'd like to send the alert to. You can optionally specify tags here to include in the notification.
61+
62+
![Discord issue alert action settings](discord-action-form.png)
63+
64+
The channel field must be filled in with a Discord channel ID, _not_ a channel name. To get this channel ID, enable Discord's Developer Mode (**Settings -> Advanced -> Developer Mode**).
65+
66+
![Discord Developer Mode Setting](discord-developer-mode.png)
67+
68+
With Developer Mode is enabled, you'll be able to right click on a channel and copy the channel's ID.
69+
70+
1. Test your configuration by clicking "Send Test Notification". If the bot has access to the given channel, you should see an example notification there.
71+
72+
![Discord issue alert](discord-issue-alert.png)
73+
74+
### Identity Linking
75+
76+
Having your Discord account linked to your Sentry account allows you to resolve, archive, and assign issues directly in Discord.
77+
78+
If you're the user who installed the Discord bot to your server, your identity was linked during the install process. You can use the `/link` command to verify this. The bot will tell you which Sentry account your Discord account is linked to.
79+
80+
All users in any Discord server with the Sentry bot can use the `/link` command to link their accounts. If the account isn't linked yet, the bot will reply with a link to our identity linking page. Make sure you're signed into the desired Sentry account in your browser when you open the link. Click "Link with Discord" to link your accounts.
81+
82+
![Discord identity linking page](discord-identity-link-page.png)
83+
84+
To unlink your accounts, use the `/unlink` command. Follow the link and click "Unlink from Discord"

src/docs/product/accounts/early-adopter-features/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ Limitations:
2424
- [Issue Reprocessing](/product/issues/reprocessing/)
2525
- [Span Summary](/product/performance/transaction-summary/#span-summary)
2626
- [Issue Archiving](/product/accounts/early-adopter-features/issue-archiving/)
27+
- [Discord Integration](/product/accounts/early-adopter-features/discord/)

0 commit comments

Comments
 (0)