Discord

Reading time: 0 minute(s) (0 words)

The Discord Alert Method enables sending alerts through Discord to notify Nobl9 users whenever an incident is triggered.

Authentication

To set up the Discord integration, you’ll need to provide a Discord Webhook URL. This allows you to send an automated notification to a channel of your choice. For details, see Discord documentation.

Configuring the Discord Alert Method

You can configure your Discord Alert Method directly in the Nobl9 UI, or by applying a YAML file in sloctl.

Nobl9 UI

To set up the Alert Method in the Nobl9 UI, follow these steps:

1. Navigate to Integrations > Alert Methods.
2. Click the button.
3. Click the relevant Alert Method icon.

Then, in the Discord Configuration Wizard:

1. Enter the URL.
   This is your Discord Webhook URL. For more information, refer to the Authentication section.

2. Select a Project.
   Specifying a Project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank then object is assigned to project default.
3. Enter a Display Name.
   You can enter a friendly name with spaces in this field.
4. Enter a Name.
   The name is mandatory and can only contain lowercase, alphanumeric characters and dashes (for example, my-alert-method-name). This field is populated automatically when you enter a display name, but you can edit the result.
5. Enter a Description.
   Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it.
6. Click the Add Alert Method button.

YAML Configuration

YAML

Here’s a general specification for adding a Discord Alert Method through YAML:

apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
  name: string # Name of the Integration
  displayName: string # optional
  project: default
spec:
  description: string # optional
  discord:
    url: # URL to Discord webhook

Example

Here's an example of Discord configuration through YAML:

apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
  name: discord-notification
  displayName: Discord notification
spec:
  description: Sends message to Discord channel through webhook
  discord:
    # Nobl9 general Discord channel
    url: <https://discord.com/api/webhooks/809803263775211571/D4-5q51DehrBpOAFND6naV8MgCQwmu1vpAwXrO8vPVflFt1bo6J0wMXzvFAttb_2CRjv>

Testing the Discord Alert Method in the UI

Users can test their Alert Methods for all notification services supported by the Nobl9 platform through the UI.

To verify that your Alert Method is set up correctly at the time that you configure it:

1. Navigate to Integrations > Alert Methods.
2. Follow the process outlined above to add the Alert Method in the Nobl9 UI: complete the steps in the Create Alert Method wizard, and Click the Add Alert Method button.
3. On the Details screen, click the Test button in the upper-right corner. If the configuration is correct, Nobl9 will display the following message next to the button: Test completed successfully!

note

If the configuration is incorrect, Nobl9 will provide an error message with relevant details. The content of the error differs depending on the Alert Method channel.

You can also test an existing Alert Method. To do that:

1. Navigate to Integrations > Alert Methods.
2. Find the Alert Method you want to test in the list, and click it.
3. On the Details screen, click the Test button in the upper-right corner.

Useful links

Discord Alert Method | Terraform Documentation