-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update documentation on setting up email and discord notifications.
- Loading branch information
Tai Shi Ling
committed
Feb 20, 2024
1 parent
f3c01a5
commit 5b85812
Showing
4 changed files
with
20 additions
and
62 deletions.
There are no files selected for viewing
Binary file added
BIN
+241 KB
.../public/static/img/discord-notifications/discord-notification-setup-webhook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
70 changes: 15 additions & 55 deletions
70
how-to-guides/Setting-up-jobs/set-up-discord-notifications.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,75 +1,35 @@ | ||
--- | ||
# Write a short description about the page. This will be displayed on google search results. | ||
description: Learn how to setup scheduled job notification on UIlicious via Discord webhook. | ||
description: In this guide, learn how to setup Discord notifications for jobs. | ||
--- | ||
|
||
# Set up Discord Notifications | ||
# Setting Discord Notifications for Jobs | ||
|
||
In this section, you will learn how to set up notifications on Discord using their provided webhook. | ||
You can setup jobs to set notifications about the test outcomes to specific channels in your Discord server. | ||
|
||
This section will guide you through the steps of setting up and integrating Discord Webhooks with UIlicious. It will provide you with a brief overview of Discord. | ||
In article, we'll cover how to setup notifications for jobs in Discord. | ||
|
||
* [Prerequisites](set-up-discord-notifications.md#prerequisites) | ||
* Setting up Discord Notifications in UIlicious | ||
* Step 1: [View the Notifications Section in UIlicious](set-up-discord-notifications.md#step-1-view-the-notifications-section-in-uilicious) | ||
* Step 2: [Making a Webhook URL in Discord](set-up-discord-notifications.md#step-2-making-a-webhook-in-discord) | ||
* Step 3: [Add the Webhook URL to Your UIlicious Notification Settings](set-up-discord-notifications.md#step-3-add-the-webhook-url-into-your-uilicious-notification-settings) | ||
[[toc]] | ||
|
||
Once you have properly configured your webhook URL and added it to your Notification Settings, UIlicious can send test run alerts to your Discord channel. | ||
## Step 1: Creating a webhook on Discord | ||
|
||
### Prerequisites | ||
First, open "**Server Settings**" on your Discord Server. | ||
|
||
* Active Discord Account | ||
* Know how to [Schedule an Automated Job](./schedule-a-job.html) | ||
* Basic Knowledge of Webhooks | ||
![](/static/img/discord-notifications/Discord_Server_Settings.png) | ||
|
||
### Step 1: View the Notifications Section in UIlicious | ||
Next, under "Apps", click "**Integrations**". Then, click "**Create Webhook**". | ||
|
||
To view the Notifications section, you can open the **Monitoring** tab in UIlicious studio. | ||
![](/static/img/discord-notifications/Discord_Webhook_Button.png) | ||
|
||
![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1652652332/ui-licious/setting-up-notifications/monitoring-tab-active.png) | ||
|
||
In **Monitoring**, you can view your complete list of jobs. | ||
Now, **enter a name** for the bot (e.g. UI-licious Jobs), and **select a channel** for receiving the notifications. Then, click "**Copy Webhook URL**". | ||
|
||
Then, click on the **Schedule New Job** button. | ||
![](/static/img/discord-notifications/discord-notification-setup-webhook.png) | ||
|
||
![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1649282897/UI-licious:%20Monitoring/scheduleaJob-2\_klnawl.png) | ||
## Step 2: Configure Discord Notification for Job | ||
|
||
Scroll down to the **Notifications** section. | ||
Open the Settings for the job. Under "Notifications", **enable "Notify by Webhook"**, **select "Others"** for the type of Webhook, and **paste the Webhook URL**. Save the changes. | ||
|
||
![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1652652712/ui-licious/setting-up-notifications/scroll-to-notifications-section.gif) | ||
![](/static/img/discord-notifications/Uilicious_Discord_webhook.png) | ||
|
||
Click the toggle next to **Notify by Webhook**. | ||
|
||
Then, open the dropdown menu next to **Webhook** and select **Others**. | ||
|
||
![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1652652028/ui-licious/setting-up-notifications/toggle\_on\_webhooks.gif) | ||
|
||
### Step 2: Making a Webhook in Discord | ||
|
||
Now, that we know where our Webhook URL goes in UIlicious, let's create our Webhook in Discord. | ||
|
||
Open **Server Settings** in Discord. | ||
|
||
![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1652654139/ui-licious/setting-up-notifications/scroll-to-Server-Settings-in-Discord.png) | ||
|
||
Open the **Integrations** tab, and select **Create Webhook**. | ||
|
||
![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1652654319/ui-licious/setting-up-notifications/go-to-integrations-and-select-create-webhook\_wjhupu.png) | ||
|
||
Feel free to customize your avatar and name your Webhook. | ||
|
||
Click the **Channel** name that you would like UIlicious to send notifications to. | ||
|
||
Then, click **Copy Webhook URL**. | ||
|
||
![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1652654609/ui-licious/setting-up-notifications/customize-your-webhook.png) | ||
|
||
### Step 3: Add the Webhook URL into Your UIlicious Notification Settings | ||
|
||
Now, that we have our Webhook URL, let's paste it in your UIlicious Notification Settings. | ||
|
||
Then, click the **Schedule** button. | ||
|
||
![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1652655093/ui-licious/setting-up-notifications/paste-your-webhook-URL-into\_UIlicious\_r0d0hf.png) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,10 +5,8 @@ description: Learn how to setup scheduled job notification on UIlicious via emai | |
|
||
# Set up Email Notifications | ||
|
||
When scheduling a new job, you have the option to **Notify by Email** by turning the toggle on.  | ||
You can setup jobs to send notifications to email. | ||
|
||
![Turning on the toggle next to Notify by Email allows you to input your choice of email(s) to be notified of test run results.](https://res.cloudinary.com/di7y5b6ed/image/upload/v1652630231/ui-licious/setting-up-notifications/open-up-email-notifications.gif) | ||
Enable "**Notify by Email**" in the Job Settings, and add one or more email addresses for receiving the notification, separated by comma. | ||
|
||
Enter your e-mail address.  | ||
|
||
If you want to send notifications to multiple emails, use a common (ex. [email protected], [email protected]). | ||
![Setting up email notifications for a job](/static/img/job-notifications/Job_Email_Notification.png) |