Skip to content

Commit

Permalink
Fold in feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
nghi-ly committed Nov 3, 2023
1 parent 6839f1f commit e6a7190
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 18 deletions.
40 changes: 22 additions & 18 deletions website/docs/docs/deploy/job-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,30 @@ Set up notifications in dbt Cloud to receive email or Slack alerts when a job ru

## Email notifications

You can receive email alerts by configuring the dbt Cloud notification settings. As a **user**, you can set up email notifications for yourself. As an **admin**, you can set up notifications for yourself and other team members. Refer to [Users and licenses](/docs/cloud/manage-access/seats-and-users) for details on license types that are eligible for email notifications.
You can receive email alerts about jobs by configuring the dbt Cloud email notification settings. Refer to [Users and licenses](/docs/cloud/manage-access/seats-and-users) for details on license types that are eligible for email notifications.

### Prerequisites
- You must be either a _developer user_ or an _account admin_ to configure email notifications in dbt Cloud.
- 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.

### Configure email notifications

1. From the gear menu in the upper right corner, choose **Notification settings**.
1. By default, the **Notification email** option is set to the email address that's in [your dbt Cloud personal profile](https://cloud.getdbt.com/settings/profile).
1. By default, dbt Cloud sends notifications to the email address that's in your [User profile](https://cloud.getdbt.com/settings/profile) page.

If you're an **admin**, you can choose a different email address. Select the **Notification email** dropdown and choose another address from the list. The list includes internal users with access to the account and also 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.
If you're an account admin, you can choose a different email address to send notifications to. Select the **Notification email** dropdown and choose another address from the list. The list includes **Internal Users** with access to the account and also **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).

<Lightbox src="/img/docs/deploy/example-notification-external-email.png" width="50%" title="Example of the Notification email dropdown"/>

1. Select the **Environment** (in the dropdown) for the jobs you want to receive notifications about.

1. Click **Edit** to configure the email notification settings.

- If you're a **user**, choose one or more of the run statuses (**Succeeds**, **Fails**, **Is Canceled**) for each job you want to receive notifications for.

- If you're an **admin**, use the **Configure notifications for** dropdown to select all the users you want to sent notifications to. Then, choose one or more of the run statuses (**Succeeds**, **Fails**, **Is Canceled**) for each job you want them to receive notifications for.
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.

1. When you're done with the settings, click **Save**.

To set up alerts on jobs from a different environment, select another **Environment** from the dropdown, **Edit** those job notification settings, and click **Save**.
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-email-notification-settings-page.png" width="100%" title="Example of the Email notifications page"/>

Expand All @@ -40,18 +41,19 @@ You can receive email alerts by configuring the dbt Cloud notification settings.

## Slack notifications

You can receive Slack alerts by setting up the Slack integration first, then configuring the dbt Cloud notification settings.
You can receive Slack alerts about jobs by setting up the Slack integration, then configuring the dbt Cloud Slack notification settings.

:::note
If there have been changes to the user roles and you need to move ownership, please [contact support](mailto:[email protected]) and provide the necessary information for them to make this change for you.
Any account admin can edit the Slack notifications but they'll be limited to configuring the channels that the 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 to configure Slack notifications in dbt Cloud.
- You must be an administrator of the Slack workspace.
- You must be an account admin to configure Slack notifications in dbt Cloud.

### Set up the Slack integration

1. Go to your [Personal profile](https://cloud.getdbt.com/settings/profile) page and scroll to the **Linked accounts** section.
1. Go to your [User profile](https://cloud.getdbt.com/settings/profile) page and 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.
Expand All @@ -64,14 +66,16 @@ If there have been changes to the user roles and you need to move ownership, ple
1. Select the **Notification channel** (in the dropdown) you want to send the job run notifications to.
<Lightbox src="/img/docs/deploy/example-notification-slack-channels.png" width="75%" title="Example of the Notification channel dropdown"/>
1. Select the **Environment** (in the dropdown) for the jobs you want to receive notifications about.
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 for.
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 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. Go to your [Personal profile](https://cloud.getdbt.com/settings/profile) page and scroll to the **Linked accounts** section.
1. Find the Slack application in the **Linked accounts** section, click the trash can icon, and click **Unlink**. The Slack notification settings are no longer active.
1. Go to your [User profile](https://cloud.getdbt.com/settings/profile) page and scroll to the **Linked accounts** section.
1. Find the Slack application in the **Linked accounts** section, click the trash can icon, and click **Unlink**. You will no longer receive Slack notifications. However, other account admins might still receive the notifications. If they want to stop receiving the notifications, they can update their [Slack notification configuration](#configure-slack-notifications) or disable the Slack integration on their dbt Cloud account.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e6a7190

Please sign in to comment.