-
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 guide on setting up email, discord, and teams notifications.
- Loading branch information
Tai Shi Ling
committed
Feb 20, 2024
1 parent
5b85812
commit 9dfb39d
Showing
39 changed files
with
43 additions
and
99 deletions.
There are no files selected for viewing
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added
BIN
+308 KB
...ublic/static/img/jobs/teams-notifications/jobs__teams__example-notification.png
Oops, something went wrong.
Binary file added
BIN
+291 KB
.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step1.png
Oops, something went wrong.
Binary file added
BIN
+452 KB
.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step2.png
Oops, something went wrong.
Binary file added
BIN
+333 KB
.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step3.png
Oops, something went wrong.
Binary file added
BIN
+333 KB
.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step4.png
Oops, something went wrong.
Binary file added
BIN
+1.53 MB
.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step5.png
Oops, something went wrong.
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
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
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
98 changes: 21 additions & 77 deletions
98
how-to-guides/Setting-up-jobs/set-up-microsoft-teams-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,101 +1,45 @@ | ||
| --- | ||
| # 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 Microsoft Teams webhooks. | ||
| description: In this guide, learn how to setup notifications on Microsoft Team for scheduled jobs | ||
| --- | ||
|
|
||
| # Set up Microsoft Teams Notifications | ||
| # Setting up Microsoft Teams notifications for Jobs | ||
|
|
||
| In this section, you will learn how to set up notifications on Teams. | ||
| You can setup notifications for the outcomes of tests triggered by jobs on Microsoft Teams. | ||
|
|
||
| This section will guide you through the steps of setting up and integrating Teams with UIlicious. | ||
|  | ||
|
|
||
| * [Prerequisites](set-up-microsoft-teams-notifications.md#prerequisites) | ||
| * Setting up Teams Notifications in UIlicious | ||
| * Step 1: [View the Notifications Section in UIlicious](set-up-microsoft-teams-notifications.md#step-1-view-the-notifications-section-in-uilicious) | ||
| * Step 2: [Making a Webhook with Teams](set-up-microsoft-teams-notifications.md#step-2-making-a-webhook-with-teams) | ||
| * Step 3: [Add the Webhook URL to Your UIlicious Notification Settings](set-up-microsoft-teams-notifications.md#step-3-add-the-webhook-url-to-your-uilicious-notification-settings) | ||
| * [UIlicious Notification in Teams Example](set-up-microsoft-teams-notifications.md#uilicious-notification-in-teams-example) | ||
| In this guide, we'll cover the steps to setup notifications on Microsoft Teams. | ||
|
|
||
| Once you have properly configured your webhook URL and added it to your Notification Settings, UIlicious can send test run alerts to your Teams. | ||
| [[toc]] | ||
|
|
||
| ### Prerequisites | ||
| ## Step 1: Create Incoming Webhook on Microsoft Teams | ||
|
|
||
| * Active Teams Account | ||
| * Know how to [Schedule an Automated Job](./schedule-a-job.html) | ||
| First, open the **Settings** for the channel where you want to receive notifications. | ||
|
|
||
| ### Step 1: View the Notifications Section in UIlicious | ||
| Under "**Connectors**", click "**Edit**". | ||
|
|
||
| To view the Notifications section, you can open the **Monitoring** tab in UIlicious studio. | ||
|  | ||
|
|
||
|  | ||
| Search for "**Incoming Webhooks**", and click "**Configure**" to add a new Webhook. If "Incoming Webhook" is not available as a connector, please contact your Microsoft Teams administrator to enable the connector for your team. | ||
|
|
||
| In **Monitoring**, you can view your complete list of jobs. | ||
|  | ||
|
|
||
| Then, click on the **Schedule New Job** button. | ||
| **Enter a name** for the webhook, for example "UI-licious Job", then click "Create". | ||
|
|
||
|  | ||
|  | ||
|
|
||
| Name your job. | ||
| Once the webhook is created, **copy the webhook URL**. | ||
|
|
||
| Then, scroll down to the **Notifications** section. | ||
|  | ||
|
|
||
|  | ||
|
|
||
| **Note**: You can choose **When** to receive notifications, there are two options available: \ | ||
| **Always** or **Error**. | ||
| ## Step 2: Configure Webhook Notification for job | ||
|
|
||
|  | ||
| Open the settings for the job, and under "Notifications", **enable "Notify by Webhook"**, **select "Microsoft Teams"** as the type of Webhook, and paste the webhook URL. Save the changes. | ||
|
|
||
| Next, click the toggle next to **Notify by Webhook**. | ||
|  | ||
|
|
||
| Then, open the dropdown menu next to **Webhook** and **** select **Microsoft Teams**. | ||
| Once configured, you will start receiving notifications on test outcomes in your Microsoft Teams channel. | ||
|
|
||
|  | ||
|
|
||
| ### Step 2: Making a Webhook with Teams | ||
|
|
||
| First, launch the Microsoft Teams application. | ||
|
|
||
| Next, click the **Apps** icon. | ||
|
|
||
|  | ||
|
|
||
| Then, search for "**Incoming Webhooks**". | ||
|
|
||
|  | ||
|
|
||
| Click the **Add to a team** button. | ||
|
|
||
|  | ||
|
|
||
| Then, click **Setup a Connector**. | ||
|
|
||
|  | ||
|
|
||
| Click **Configure,** and add a name for your Webhook. | ||
|
|
||
|  | ||
|
|
||
| Name your Webhook. | ||
|
|
||
| Then, click **Create**. | ||
|
|
||
|  | ||
|
|
||
| Next, copy your Webhook URL as we will use this in your UIlicious Notifications Settings. | ||
|
|
||
| Just a heads-up, this is what successfully setting up a Webhook looks like: | ||
|
|
||
|  | ||
|
|
||
| ### Step 3: Add the Webhook URL to Your UIlicious Notification Settings  | ||
|
|
||
| Head back to UIlicious and scroll down to the Notifications section. | ||
|
|
||
| Next to Webhook URL, paste in the URL that you copied earlier. | ||
|
|
||
|  | ||
|
|
||
| ### UIlicious Notification in Teams Example | ||
|
|
||
|  | ||
|  |