Skip to content

Add Discord integration docs #7645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Aug 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
84 changes: 84 additions & 0 deletions src/docs/product/accounts/early-adopter-features/discord/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: Discord Integration
sidebar_order: 1
description: "Learn more about Sentry's Discord integration and how you can get notified and manage issues right in Discord."
---

<Include name="feature-available-for-user-group-early-adopter.mdx" />

Get notified and manage issues right in Discord with Sentry's Discord integration.

## Install

<Note>

Sentry owner, manager, or admin permissions are required to install this integration.

</Note>

1. In [sentry.io](https://sentry.io), nagivate to **Settings > Integrations > Discord**.

1. Click "Add Installation". A pop up window should open.

![Install Discord integration](discord-integration-details.png)

1. Log in to your Discord account. If you're already logged in, this login step will not be displayed.

1. Use the dropdown menu to select the Discord server you'd like to add Sentry to and click "Continue".

<Note>
You will need to have the "Manage Server" permission enabled for your
Discord account in the server you're trying to add the bot to.
</Note>

![Select server](discord-server-select.png)

1. Finally, once the server is selected, click "Authorize". The integration will be created and the Sentry Discord bot will join the selected server.

Your Discord integration is now available to all projects in your Sentry organization.

In the next section, we'll walk through configuring Discord notifications.

## Configure

Currently our Discord integration supports issue alert rules, with metric alerts and personal notifications planned for future updates to the integration.

### Issue Alerts

Follow the steps below to create a new issue alert that sends Discord notifications.

1. In Sentry, go to **Alerts** and click "Create Alert".

1. Select "Issues" and then click "Set Conditions".

![Create issue alert](discord-add-issue-alert.png)

1. Configure your issue alert conditions as desired.

1. To set up Discord notifications, select "Send a Discord notification" in the "THEN" actions dropdown.

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.

![Discord issue alert action settings](discord-action-form.png)

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**).

![Discord Developer Mode Setting](discord-developer-mode.png)

With Developer Mode is enabled, you'll be able to right click on a channel and copy the channel's ID.

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.

![Discord issue alert](discord-issue-alert.png)

### Identity Linking

Having your Discord account linked to your Sentry account allows you to resolve, archive, and assign issues directly in Discord.

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.

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.

![Discord identity linking page](discord-identity-link-page.png)

To unlink your accounts, use the `/unlink` command. Follow the link and click "Unlink from Discord"
1 change: 1 addition & 0 deletions src/docs/product/accounts/early-adopter-features/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ Limitations:
- [Issue Reprocessing](/product/issues/reprocessing/)
- [Span Summary](/product/performance/transaction-summary/#span-summary)
- [Issue Archiving](/product/accounts/early-adopter-features/issue-archiving/)
- [Discord Integration](/product/accounts/early-adopter-features/discord/)
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ You can receive [team alert notifications](/product/alerts/create-alerts/issue-a

### Alert Rules

Set up an alert rule by going to **Alerts** and clicking "Create Alert\*". From here, you can configure alerts to route notifications to your Slack workspace(s).
Set up an alert rule by going to **Alerts** and clicking "Create Alert". From here, you can configure alerts to route notifications to your Slack workspace(s).

In [issue alerts](/product/alerts/alert-types/#issue-alerts), select "Send a Slack notification" in the actions dropdown and then select your workspace and channel:

Expand Down