-
Notifications
You must be signed in to change notification settings - Fork 960
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'current' into mwong-remove-callout
- Loading branch information
Showing
20 changed files
with
145 additions
and
74 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,83 @@ | ||
--- | ||
title: "Job notifications" | ||
id: "job-notifications" | ||
description: "Set up notifications in dbt Cloud to receive Email or Slack alerts for job run status." | ||
description: "Set up notifications in dbt Cloud to receive email or Slack alerts about job run status." | ||
--- | ||
|
||
Set up notifications in dbt Cloud to receive email or Slack alerts when a job run succeeds, fails, or is cancelled. | ||
|
||
Setting up notifications in dbt Cloud will allow you to receive alerts via Email or a chosen Slack channel when a job run succeeds, fails, or is cancelled. | ||
## Email notifications | ||
|
||
You can receive email alerts about jobs by configuring the dbt Cloud email notification settings. | ||
|
||
These are the following options for setting up email notifications. Refer to [Users and licenses](/docs/cloud/manage-access/seats-and-users) for info on license types eligible for email notifications. | ||
### Prerequisites | ||
- You must be either a _developer user_ or an _account admin_ to configure email notifications in dbt Cloud. For more details, refer to [Users and licenses](/docs/cloud/manage-access/seats-and-users). | ||
- As a developer user, you can set up email notifications for yourself. | ||
- As an account admin, you can set up notifications for yourself and other team members. | ||
|
||
- As a **user** — You can set up email notifications for yourself under your Profile. | ||
- As an **admin** — You can set up notifications on behalf of your team members. | ||
### Configure email notifications | ||
|
||
To set up job notifications, follow these steps: | ||
1. From the gear menu, choose **Notification settings**. | ||
1. By default, dbt Cloud sends notifications to the email address that's in your **User profile** page. | ||
|
||
1. Click the gear menu in the top right corner and select **Notification Settings**. | ||
If you're an account admin, you can choose a different email address to receive notifications. Select the **Notification email** dropdown and choose another address from the list. The list includes **Internal Users** with access to the account and **External Emails** that have been added. | ||
- To add an external email address, select the **Notification email** dropdown and choose **Add external email**. After you add the external email, it becomes available for selection in the **Notification email** dropdown list. External emails can be addresses that are outside of your dbt Cloud account and also for third-party integrations like [channels in Microsoft Teams](https://support.microsoft.com/en-us/office/tip-send-email-to-a-channel-2c17dbae-acdf-4209-a761-b463bdaaa4ca) and [PagerDuty email integration](https://support.pagerduty.com/docs/email-integration-guide). | ||
|
||
2. Select **Edit** to begin editing the **Email Notifications** settings. | ||
- **As a user:** Choose the Notification type (Succeeds, Fails, or Is Cancelled) for each Job you want to receive notifications for. | ||
<Lightbox src="/img/docs/deploy/example-notification-external-email.png" width="50%" title="Example of the Notification email dropdown"/> | ||
|
||
- **As an admin:** Under **Configure notifications for**, use the dropdown to select one or more users you'd like to set notifications for. If you only see your own name, then you might not have admin privileges. <br /><br /> | ||
Choose the Notification type (Succeeds, Fails, or Is Cancelled) for each Job you want them to receive notifications for. | ||
1. Select the **Environment** for the jobs you want to receive notifications about from the dropdown. | ||
|
||
3. Click **Save**. | ||
1. Click **Edit** to configure the email notification settings. Choose one or more of the run statuses (**Succeeds**, **Fails**, **Is Canceled**) for each job you want to receive notifications about. | ||
|
||
<Lightbox src="/img/docs/dbt-cloud/using-dbt-cloud/email-notifications.png" width="75%" title="Configuring Email Notifications"/> | ||
1. When you're done with the settings, click **Save**. | ||
|
||
### Slack | ||
As an account admin, you can add more email recipients by choosing another **Notification email** from the dropdown, **Edit** the job notification settings, and **Save** the changes. | ||
|
||
To set up alerts on jobs from a different environment, select another **Environment** from the dropdown, **Edit** those job notification settings, and **Save** the changes. | ||
|
||
<Snippet path="slack-notifications-config-steps" /> | ||
<Lightbox src="/img/docs/deploy/example-email-notification-settings-page.png" width="100%" title="Example of the Email notifications page"/> | ||
|
||
### Unsubscribe from email notifications | ||
1. From the gear menu, choose **Notification settings**. | ||
1. On the **Email notifications** page, click **Unsubscribe from all email notifications**. | ||
|
||
## Slack notifications | ||
|
||
You can receive Slack alerts about jobs by setting up the Slack integration, then configuring the dbt Cloud Slack notification settings. | ||
|
||
:::note | ||
Any account admin can edit the Slack notifications but they'll be limited to configuring the channels that their Slack user has access to. If there has been a change in user roles or Slack permissions where you no longer have access to edit a configured Slack channel, please [contact support](mailto:[email protected]) for assistance. | ||
::: | ||
|
||
### Prerequisites | ||
- You must be an administrator of the Slack workspace. | ||
- You must be an account admin to configure Slack notifications in dbt Cloud. For more details, refer to [Users and licenses](/docs/cloud/manage-access/seats-and-users). | ||
|
||
### Set up the Slack integration | ||
|
||
1. From the gear menu, select **Profile settings**. On your **User profile** page, scroll to the **Linked accounts** section. | ||
1. In the **Linked accounts** section, find the Slack application and click **Link**. | ||
<Lightbox src="/img/docs/dbt-cloud/Link-your-Slack-Profile.png" width="75%" title="Link for the Slack app"/> | ||
1. Allow dbt Labs to access the Slack workspace. If you are a member of multiple workspaces, you can select the appropriate workspace from the dropdown menu in the upper right corner. | ||
<Lightbox src="/img/docs/dbt-cloud/Allow-dbt-to-access-slack.png" width="75%" title="Allow dbt access to Slack"/> | ||
|
||
### Configure Slack notifications | ||
|
||
1. From the gear menu, choose **Notification settings**. | ||
1. Select **Slack notifications** in the left sidebar. | ||
1. Select the **Notification channel** you want to receive the job run notifications from the dropdown. | ||
<Lightbox src="/img/docs/deploy/example-notification-slack-channels.png" width="75%" title="Example of the Notification channel dropdown"/> | ||
1. Select the **Environment** for the jobs you want to receive notifications about from the dropdown. | ||
1. Click **Edit** to configure the Slack notification settings. Choose one or more of the run statuses (**Succeeds**, **Fails**, **Is Canceled**) for each job you want to receive notifications about. | ||
1. When you're done with the settings, click **Save**. | ||
|
||
To send alerts to another Slack channel, select another **Notification channel** from the dropdown, **Edit** those job notification settings, and **Save** the changes. | ||
|
||
To set up alerts on jobs from a different environment, select another **Environment** from the dropdown, **Edit** those job notification settings, and **Save** the changes. | ||
|
||
<Lightbox src="/img/docs/deploy/example-slack-notification-settings-page.png" width="100%" title="Example of the Slack notifications page"/> | ||
|
||
### Disable the Slack integration | ||
|
||
1. From the gear menu, select **Profile settings**. On your **User profile** page, scroll to the **Linked accounts** section. | ||
1. Find the Slack application in the **Linked accounts** section, click the trash can icon, and click **Unlink**. Channels that you configured will no longer receive Slack notifications. Channels that are configured by other account admins will continue to receive Slack notifications if they still have active Slack integrations. To migrate ownership of a Slack channel notification configuration, have another account admin edit the configuration. |
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 was deleted.
Oops, something went wrong.
This file was deleted.
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
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
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Binary file not shown.
Binary file removed
BIN
-161 KB
website/static/img/docs/dbt-cloud/using-dbt-cloud/email-notifications.png
Binary file not shown.
Binary file added
BIN
+64.7 KB
website/static/img/docs/deploy/example-email-notification-settings-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+33.4 KB
website/static/img/docs/deploy/example-notification-external-email.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+170 KB
website/static/img/docs/deploy/example-notification-slack-channels.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+78.6 KB
website/static/img/docs/deploy/example-slack-notification-settings-page.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