diff --git a/.vuepress/public/static/img/job-notifications/Enter_Job_Name.png b/.vuepress/public/static/img/jobs/Enter_Job_Name.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Enter_Job_Name.png rename to .vuepress/public/static/img/jobs/Enter_Job_Name.png diff --git a/.vuepress/public/static/img/job-notifications/Job_Configuration.png b/.vuepress/public/static/img/jobs/Job_Configuration.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Job_Configuration.png rename to .vuepress/public/static/img/jobs/Job_Configuration.png diff --git a/.vuepress/public/static/img/job-notifications/Job_Delete_Button.png b/.vuepress/public/static/img/jobs/Job_Delete_Button.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Job_Delete_Button.png rename to .vuepress/public/static/img/jobs/Job_Delete_Button.png diff --git a/.vuepress/public/static/img/job-notifications/Job_Delete_Confirmation.png b/.vuepress/public/static/img/jobs/Job_Delete_Confirmation.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Job_Delete_Confirmation.png rename to .vuepress/public/static/img/jobs/Job_Delete_Confirmation.png diff --git a/.vuepress/public/static/img/job-notifications/Job_Disable_Button.png b/.vuepress/public/static/img/jobs/Job_Disable_Button.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Job_Disable_Button.png rename to .vuepress/public/static/img/jobs/Job_Disable_Button.png diff --git a/.vuepress/public/static/img/job-notifications/Job_Disable_Confirmation.png b/.vuepress/public/static/img/jobs/Job_Disable_Confirmation.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Job_Disable_Confirmation.png rename to .vuepress/public/static/img/jobs/Job_Disable_Confirmation.png diff --git a/.vuepress/public/static/img/job-notifications/Job_Disabled_State.png b/.vuepress/public/static/img/jobs/Job_Disabled_State.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Job_Disabled_State.png rename to .vuepress/public/static/img/jobs/Job_Disabled_State.png diff --git a/.vuepress/public/static/img/job-notifications/Job_Email_Notification.png b/.vuepress/public/static/img/jobs/Job_Email_Notification.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Job_Email_Notification.png rename to .vuepress/public/static/img/jobs/Job_Email_Notification.png diff --git a/.vuepress/public/static/img/job-notifications/Job_Schedule.png b/.vuepress/public/static/img/jobs/Job_Schedule.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Job_Schedule.png rename to .vuepress/public/static/img/jobs/Job_Schedule.png diff --git a/.vuepress/public/static/img/job-notifications/Schedule_Button_At_Editor.png b/.vuepress/public/static/img/jobs/Schedule_Button_At_Editor.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Schedule_Button_At_Editor.png rename to .vuepress/public/static/img/jobs/Schedule_Button_At_Editor.png diff --git a/.vuepress/public/static/img/job-notifications/Schedule_Button_At_Monitoring.png b/.vuepress/public/static/img/jobs/Schedule_Button_At_Monitoring.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Schedule_Button_At_Monitoring.png rename to .vuepress/public/static/img/jobs/Schedule_Button_At_Monitoring.png diff --git a/.vuepress/public/static/img/job-notifications/Select_Test_For_Job.png b/.vuepress/public/static/img/jobs/Select_Test_For_Job.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/Select_Test_For_Job.png rename to .vuepress/public/static/img/jobs/Select_Test_For_Job.png diff --git a/.vuepress/public/static/img/discord-notifications/Discord_Server_Settings.png b/.vuepress/public/static/img/jobs/discord-notifications/Discord_Server_Settings.png similarity index 100% rename from .vuepress/public/static/img/discord-notifications/Discord_Server_Settings.png rename to .vuepress/public/static/img/jobs/discord-notifications/Discord_Server_Settings.png diff --git a/.vuepress/public/static/img/discord-notifications/Discord_Webhook.png b/.vuepress/public/static/img/jobs/discord-notifications/Discord_Webhook.png similarity index 100% rename from .vuepress/public/static/img/discord-notifications/Discord_Webhook.png rename to .vuepress/public/static/img/jobs/discord-notifications/Discord_Webhook.png diff --git a/.vuepress/public/static/img/discord-notifications/Discord_Webhook_Button.png b/.vuepress/public/static/img/jobs/discord-notifications/Discord_Webhook_Button.png similarity index 100% rename from .vuepress/public/static/img/discord-notifications/Discord_Webhook_Button.png rename to .vuepress/public/static/img/jobs/discord-notifications/Discord_Webhook_Button.png diff --git a/.vuepress/public/static/img/discord-notifications/Uilicious_Discord_webhook.png b/.vuepress/public/static/img/jobs/discord-notifications/Uilicious_Discord_webhook.png similarity index 100% rename from .vuepress/public/static/img/discord-notifications/Uilicious_Discord_webhook.png rename to .vuepress/public/static/img/jobs/discord-notifications/Uilicious_Discord_webhook.png diff --git a/.vuepress/public/static/img/jobs/discord-notifications/discord-notification-setup-webhook.png b/.vuepress/public/static/img/jobs/discord-notifications/discord-notification-setup-webhook.png new file mode 100644 index 0000000..0e5239e Binary files /dev/null and b/.vuepress/public/static/img/jobs/discord-notifications/discord-notification-setup-webhook.png differ diff --git a/.vuepress/public/static/img/job-notifications/jobs-bulk-edit.png b/.vuepress/public/static/img/jobs/jobs-bulk-edit.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs-bulk-edit.png rename to .vuepress/public/static/img/jobs/jobs-bulk-edit.png diff --git a/.vuepress/public/static/img/job-notifications/jobs-click-job-name.png b/.vuepress/public/static/img/jobs/jobs-click-job-name.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs-click-job-name.png rename to .vuepress/public/static/img/jobs/jobs-click-job-name.png diff --git a/.vuepress/public/static/img/job-notifications/jobs-enter-name.png b/.vuepress/public/static/img/jobs/jobs-enter-name.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs-enter-name.png rename to .vuepress/public/static/img/jobs/jobs-enter-name.png diff --git a/.vuepress/public/static/img/job-notifications/jobs-monitoring-page-highlight-job.png b/.vuepress/public/static/img/jobs/jobs-monitoring-page-highlight-job.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs-monitoring-page-highlight-job.png rename to .vuepress/public/static/img/jobs/jobs-monitoring-page-highlight-job.png diff --git a/.vuepress/public/static/img/job-notifications/jobs-monitoring-page-overview.png b/.vuepress/public/static/img/jobs/jobs-monitoring-page-overview.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs-monitoring-page-overview.png rename to .vuepress/public/static/img/jobs/jobs-monitoring-page-overview.png diff --git a/.vuepress/public/static/img/job-notifications/jobs-past-runs-page-for-suite-of-tests.png b/.vuepress/public/static/img/jobs/jobs-past-runs-page-for-suite-of-tests.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs-past-runs-page-for-suite-of-tests.png rename to .vuepress/public/static/img/jobs/jobs-past-runs-page-for-suite-of-tests.png diff --git a/.vuepress/public/static/img/job-notifications/jobs-past-runs-page.png b/.vuepress/public/static/img/jobs/jobs-past-runs-page.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs-past-runs-page.png rename to .vuepress/public/static/img/jobs/jobs-past-runs-page.png diff --git a/.vuepress/public/static/img/job-notifications/jobs-run-report-for-suite-of-test.png b/.vuepress/public/static/img/jobs/jobs-run-report-for-suite-of-test.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs-run-report-for-suite-of-test.png rename to .vuepress/public/static/img/jobs/jobs-run-report-for-suite-of-test.png diff --git a/.vuepress/public/static/img/job-notifications/jobs-schedule-time.png b/.vuepress/public/static/img/jobs/jobs-schedule-time.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs-schedule-time.png rename to .vuepress/public/static/img/jobs/jobs-schedule-time.png diff --git a/.vuepress/public/static/img/job-notifications/jobs-select-test.png b/.vuepress/public/static/img/jobs/jobs-select-test.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs-select-test.png rename to .vuepress/public/static/img/jobs/jobs-select-test.png diff --git a/.vuepress/public/static/img/job-notifications/jobs__single-test-run-report.png b/.vuepress/public/static/img/jobs/jobs__single-test-run-report.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs__single-test-run-report.png rename to .vuepress/public/static/img/jobs/jobs__single-test-run-report.png diff --git a/.vuepress/public/static/img/job-notifications/jobs__test-suite-run-report__click-to-view-report.png b/.vuepress/public/static/img/jobs/jobs__test-suite-run-report__click-to-view-report.png similarity index 100% rename from .vuepress/public/static/img/job-notifications/jobs__test-suite-run-report__click-to-view-report.png rename to .vuepress/public/static/img/jobs/jobs__test-suite-run-report__click-to-view-report.png diff --git a/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__example-notification.png b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__example-notification.png new file mode 100644 index 0000000..668611c Binary files /dev/null and b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__example-notification.png differ diff --git a/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step1.png b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step1.png new file mode 100644 index 0000000..373eead Binary files /dev/null and b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step1.png differ diff --git a/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step2.png b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step2.png new file mode 100644 index 0000000..b049466 Binary files /dev/null and b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step2.png differ diff --git a/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step3.png b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step3.png new file mode 100644 index 0000000..29cd78c Binary files /dev/null and b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step3.png differ diff --git a/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step4.png b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step4.png new file mode 100644 index 0000000..f775b37 Binary files /dev/null and b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step4.png differ diff --git a/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step5.png b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step5.png new file mode 100644 index 0000000..dbb5da1 Binary files /dev/null and b/.vuepress/public/static/img/jobs/teams-notifications/jobs__teams__step5.png differ diff --git a/SUMMARY.md b/SUMMARY.md index 3bd1f2d..fb6c7e2 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -24,10 +24,10 @@ * [Setting up a job](how-to-guides/Setting-up-jobs/schedule-a-job.md) * Notifications * [Email](how-to-guides/Setting-up-jobs/set-up-email-notifications.md) - * [Discord](how-to-guides/Setting-up-jobs/set-up-discord-notifications.md)x - * [Telegram](how-to-guides/Setting-up-jobs/set-up-telegram-notifications.md) * [Slack](how-to-guides/Setting-up-jobs/set-up-slack-notifications.md) * [Microsoft Teams](how-to-guides/Setting-up-jobs/set-up-microsoft-teams-notifications.md) + * [Discord](how-to-guides/Setting-up-jobs/set-up-discord-notifications.md) + * [Telegram](how-to-guides/Setting-up-jobs/set-up-telegram-notifications.md) * Integrations * Github * [Saving project to Github](how-to-guides/github/saving-projects-to-github.md) diff --git a/how-to-guides/Setting-up-jobs/schedule-a-job.md b/how-to-guides/Setting-up-jobs/schedule-a-job.md index 4424ad2..bec5049 100644 --- a/how-to-guides/Setting-up-jobs/schedule-a-job.md +++ b/how-to-guides/Setting-up-jobs/schedule-a-job.md @@ -16,76 +16,76 @@ A job is a task that executes tests on a scheduled basis. Jobs will trigger auto To start, first, select the "**Monitoring**" Tab and click "**Schedule a job**" button. -![Click the "Schedule a job" button](/static/img/job-notifications/Schedule_Button_At_Monitoring.png) +![Click the "Schedule a job" button](/static/img/jobs/Schedule_Button_At_Monitoring.png) Then, **enter a name** for the job. -![Enter a name for the job](/static/img/job-notifications/jobs-enter-name.png) +![Enter a name for the job](/static/img/jobs/jobs-enter-name.png) Now, **select the tests** that you want to run as part of this job. -![Select tests to run](/static/img/job-notifications/jobs-select-test.png) +![Select tests to run](/static/img/jobs/jobs-select-test.png) Then, **choose the browsers, resolution, dataset, region, and user agent** for running the tests. You may select more than one browser, and the job will run each test with each selected browser. -![Configure test run settings](/static/img/job-notifications/Job_Configuration.png) +![Configure test run settings](/static/img/jobs/Job_Configuration.png) Finally, **configure the schedule** for running the job. -![Select the days you want to run the job](/static/img/job-notifications/Job_Schedule.png) +![Select the days you want to run the job](/static/img/jobs/Job_Schedule.png) -![Select the times you want to run the job](/static/img/job-notifications/jobs-schedule-time.png) +![Select the times you want to run the job](/static/img/jobs/jobs-schedule-time.png) Optionally, you can **setup notifications** on the test outcomes. You can select whether you want notifications for all test outcomes `When: "Always"` or only when tests fails `When: "Error"`. You can setup **email notifications** and **notifications for chat applications** such as [Slack](./set-up-slack-notifications.md), [Teams](./set-up-microsoft-teams-notifications.md), [Telegram](./set-up-telegram-notifications.md), [Discord](./set-up-discord-notifications.md) using **webhooks**. -![](/static/img/job-notifications/Job_Email_Notification.png) +![](/static/img/jobs/Job_Email_Notification.png) Once you save the job, you can view its status from the **Monitoring** View, and click on the name of the job to view its past runs and manage the job. -![](/static/img/job-notifications/jobs-monitoring-page-highlight-job.png) +![](/static/img/jobs/jobs-monitoring-page-highlight-job.png) ## The Monitoring View The Monitoring View shows you a summary of all jobs and their most recent status. -![](/static/img/job-notifications/jobs-monitoring-page-overview.png) +![](/static/img/jobs/jobs-monitoring-page-overview.png) You can also select multiple jobs to bulk edit their run settings, schedule, and notifications. -![](/static/img/job-notifications/jobs-bulk-edit.png) +![](/static/img/jobs/jobs-bulk-edit.png) ## Viewing Past Runs You may view past runs for a job by **clicking on the name of the job** from the Monitoring View. -![Click on the name of the job to view its past runs and manage the job](/static/img/job-notifications/jobs-click-job-name.png) +![Click on the name of the job to view its past runs and manage the job](/static/img/jobs/jobs-click-job-name.png) The past runs page will show a summary of past test runs, indicating number of passing and failing tests by the browsers. -![](/static/img/job-notifications/jobs-past-runs-page-for-suite-of-tests.png) +![](/static/img/jobs/jobs-past-runs-page-for-suite-of-tests.png) Click on "**View Report**" to view the full report of a run, which will show the result of each individual test. -![](/static/img/job-notifications/jobs-run-report-for-suite-of-test.png) +![](/static/img/jobs/jobs-run-report-for-suite-of-test.png) You can view the Test Run Report for an single test run by clicking on its status. -![Click on the status of a test run to view its report](/static/img/job-notifications/jobs__test-suite-run-report__click-to-view-report.png) +![Click on the status of a test run to view its report](/static/img/jobs/jobs__test-suite-run-report__click-to-view-report.png) -![Full step-by-step report of a test run, with screenshots](/static/img/job-notifications/jobs__single-test-run-report.png) +![Full step-by-step report of a test run, with screenshots](/static/img/jobs/jobs__single-test-run-report.png) ## Disable / Enable a job You may disable a job to stop it from running at schedule times temporarily. This may be useful when you expect test failures due to changes in the application and want to pause the job while the test script is being updated. To disable a job, click the "..." button to show more actions and click "Disable" to disable the job. -![Pause a job by disabling it](/static/img/job-notifications/Job_Disable_Button.png) +![Pause a job by disabling it](/static/img/jobs/Job_Disable_Button.png) ## Delete a job To delete a job, click the "..." button to show more actions, and click "**Delete**". -![Delete a job](/static/img/job-notifications/Job_Delete_Button.png) +![Delete a job](/static/img/jobs/Job_Delete_Button.png) Once the job is deleted, you will no longer be able to access the past runs page for this job and view the aggregated run reports. To view past runs for this job, you will need to go to the "Runs" view and search for the individual test run reports. diff --git a/how-to-guides/Setting-up-jobs/set-up-discord-notifications.md b/how-to-guides/Setting-up-jobs/set-up-discord-notifications.md index c5ce7f3..539216f 100644 --- a/how-to-guides/Setting-up-jobs/set-up-discord-notifications.md +++ b/how-to-guides/Setting-up-jobs/set-up-discord-notifications.md @@ -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/jobs/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/jobs/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/jobs/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/jobs/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) diff --git a/how-to-guides/Setting-up-jobs/set-up-email-notifications.md b/how-to-guides/Setting-up-jobs/set-up-email-notifications.md index ca37d83..ac65f8b 100644 --- a/how-to-guides/Setting-up-jobs/set-up-email-notifications.md +++ b/how-to-guides/Setting-up-jobs/set-up-email-notifications.md @@ -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. test@uilicious.com, test2@uilicious.com). +![Setting up email notifications for a job](/static/img/jobs/Job_Email_Notification.png) diff --git a/how-to-guides/Setting-up-jobs/set-up-microsoft-teams-notifications.md b/how-to-guides/Setting-up-jobs/set-up-microsoft-teams-notifications.md index 55d344e..28c4c7a 100644 --- a/how-to-guides/Setting-up-jobs/set-up-microsoft-teams-notifications.md +++ b/how-to-guides/Setting-up-jobs/set-up-microsoft-teams-notifications.md @@ -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. +![Receive notifications on Microsoft Teams when tests fail](/static/img/jobs/teams-notifications/jobs__teams__example-notification.png) -* [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. +![](/static/img/jobs/teams-notifications/jobs__teams__step1.png) -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1652652332/ui-licious/setting-up-notifications/monitoring-tab-active.png) +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. +![](/static/img/jobs/teams-notifications/jobs__teams__step2.png) -Then, click on the **Schedule New Job** button. +**Enter a name** for the webhook, for example "UI-licious Job", then click "Create". -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1653413563/ui-licious/setting-up-notifications/scheduleajob\_c9hyqi.png) +![](/static/img/jobs/teams-notifications/jobs__teams__step3.png) -Name your job. +Once the webhook is created, **copy the webhook URL**. -Then, scroll down to the **Notifications** section. +![](/static/img/jobs/teams-notifications/jobs__teams__step4.png) -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1652652712/ui-licious/setting-up-notifications/scroll-to-notifications-section.gif) -**Note**: You can choose **When** to receive notifications, there are two options available: \ -**Always** or **Error**. +## Step 2: Configure Webhook Notification for job -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1653501856/ui-licious/setting-up-notifications/telegram/when-to-receive-notifications.png) +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**. +![](/static/img/jobs/teams-notifications/jobs__teams__step5.png) -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. -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1654117021/ui-licious/setting-up-notifications/teams/teams-notifications-on.gif) - -### Step 2: Making a Webhook with Teams - -First, launch the Microsoft Teams application. - -Next, click the **Apps** icon. - -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1655512636/ui-licious/setting-up-notifications/teams/teams-1\_kt8y4q.png) - -Then, search for "**Incoming Webhooks**". - -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1655512636/ui-licious/setting-up-notifications/teams/teams-2\_xsejxr.png) - -Click the **Add to a team** button. - -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1655512636/ui-licious/setting-up-notifications/teams/teams-3\_cl2brx.png) - -Then, click **Setup a Connector**. - -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1655512636/ui-licious/setting-up-notifications/teams/teams-5\_pydcb6.png) - -Click **Configure,** and add a name for your Webhook. - -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1655512636/ui-licious/setting-up-notifications/teams/teams-7\_kdtxkn.png) - -Name your Webhook. - -Then, click **Create**. - -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1655512638/ui-licious/setting-up-notifications/teams/teams-9\_eyn6fo.png) - -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: - -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1655512637/ui-licious/setting-up-notifications/teams/teams-10\_rrca2m.png) - -### 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. - -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1655513147/ui-licious/setting-up-notifications/teams/teams-example.png) - -### UIlicious Notification in Teams Example - -![](https://res.cloudinary.com/di7y5b6ed/image/upload/v1656342911/ui-licious/setting-up-notifications/teams/successful-notification-microsoft-teams\_rrnb90.png) +![Receive notifications on Microsoft Teams when tests fail](/static/img/jobs/teams-notifications/jobs__teams__example-notification.png) \ No newline at end of file