Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to email/slack job notifications #4347

Merged
merged 45 commits into from
Nov 6, 2023
Merged
Show file tree
Hide file tree
Changes from 38 commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
53da049
Updates to email/slack job notifications
nghi-ly Oct 26, 2023
2b0494c
Merge branch 'current' into ly-docs-job-notification-updates
nghi-ly Oct 26, 2023
62e9d4e
Fix broken links
nghi-ly Oct 26, 2023
93f0c46
Merge branch 'ly-docs-job-notification-updates' of github.com:dbt-lab…
nghi-ly Oct 26, 2023
47eb334
Remove comment
nghi-ly Oct 26, 2023
b7fb8db
This branch was auto-updated!
github-actions[bot] Oct 26, 2023
4d7820c
This branch was auto-updated!
github-actions[bot] Oct 26, 2023
6766517
This branch was auto-updated!
github-actions[bot] Oct 26, 2023
76f7271
This branch was auto-updated!
github-actions[bot] Oct 26, 2023
f226eb9
This branch was auto-updated!
github-actions[bot] Oct 27, 2023
dec1425
This branch was auto-updated!
github-actions[bot] Oct 27, 2023
b96ca86
This branch was auto-updated!
github-actions[bot] Oct 27, 2023
c768dfd
This branch was auto-updated!
github-actions[bot] Oct 27, 2023
978b77c
This branch was auto-updated!
github-actions[bot] Oct 27, 2023
4f265c8
This branch was auto-updated!
github-actions[bot] Oct 27, 2023
20c1caf
This branch was auto-updated!
github-actions[bot] Oct 27, 2023
1fe4b54
This branch was auto-updated!
github-actions[bot] Oct 30, 2023
17ed08c
This branch was auto-updated!
github-actions[bot] Oct 30, 2023
a2c6ce4
This branch was auto-updated!
github-actions[bot] Oct 30, 2023
2f35551
This branch was auto-updated!
github-actions[bot] Oct 30, 2023
ac393ce
This branch was auto-updated!
github-actions[bot] Oct 30, 2023
8abfa62
This branch was auto-updated!
github-actions[bot] Oct 31, 2023
c27c833
This branch was auto-updated!
github-actions[bot] Oct 31, 2023
46842d9
This branch was auto-updated!
github-actions[bot] Oct 31, 2023
43bb35d
This branch was auto-updated!
github-actions[bot] Oct 31, 2023
b190f0d
This branch was auto-updated!
github-actions[bot] Nov 1, 2023
9beaa00
This branch was auto-updated!
github-actions[bot] Nov 1, 2023
b15025d
This branch was auto-updated!
github-actions[bot] Nov 1, 2023
02558c1
This branch was auto-updated!
github-actions[bot] Nov 1, 2023
d57bd3e
This branch was auto-updated!
github-actions[bot] Nov 1, 2023
c4391f5
This branch was auto-updated!
github-actions[bot] Nov 1, 2023
6839f1f
This branch was auto-updated!
github-actions[bot] Nov 1, 2023
e6a7190
Fold in feedback
nghi-ly Nov 3, 2023
f6a1d79
Resolve merge conflict
nghi-ly Nov 3, 2023
998674c
Update both prereqs sections
nghi-ly Nov 3, 2023
55d0972
Add info about sending email alerts to more people
nghi-ly Nov 3, 2023
342101f
This branch was auto-updated!
github-actions[bot] Nov 6, 2023
bcb9d2c
This branch was auto-updated!
github-actions[bot] Nov 6, 2023
342ceeb
This branch was auto-updated!
github-actions[bot] Nov 6, 2023
e2fd5ea
Update website/docs/docs/deploy/job-notifications.md
nghi-ly Nov 6, 2023
da82aff
This branch was auto-updated!
github-actions[bot] Nov 6, 2023
6991cc8
Update website/docs/docs/deploy/job-notifications.md
nghi-ly Nov 6, 2023
6ce5749
Update website/docs/docs/deploy/job-notifications.md
nghi-ly Nov 6, 2023
c6c69b9
Fold in feedback
nghi-ly Nov 6, 2023
37dd32c
Blurred screenshots
nghi-ly Nov 6, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 66 additions & 16 deletions website/docs/docs/deploy/job-notifications.md
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

### Email
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.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
### 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 in the upper right corner, choose **Notification settings**.
1. By default, dbt Cloud sends notifications to the email address that's in your [User profile](https://cloud.getdbt.com/settings/profile) page.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved

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 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.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
- 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** (in the dropdown) for the jobs you want to receive notifications about.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved

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
If there is another person you also want to send the notifications to, as an account admin, you can select another **Notification email** from the dropdown, **Edit** the job notification settings, and **Save** the changes.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved

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 in the upper right corner, 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.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved

:::note
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:support@getdbt.com) for assistance.
GideonShils marked this conversation as resolved.
Show resolved Hide resolved
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
:::

### 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
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved

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.
<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 in the upper right corner, choose **Notification settings**.
1. Select **Slack notifications** in the left sidebar.
1. Select the **Notification channel** (in the dropdown) you want to send the job run notifications to.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
<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 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. 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.
GideonShils marked this conversation as resolved.
Show resolved Hide resolved
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 0 additions & 8 deletions website/docs/faqs/Accounts/slack.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: zapier-ms-teams
description: Use Zapier and the dbt Cloud API to post to Microsoft Teams
---

This guide will show you how to set up an integration between dbt Cloud jobs and Microsoft Teams using [dbt Cloud Webhooks](/docs/deploy/webhooks) and Zapier, similar to the [native Slack integration](/faqs/accounts/slack).
This guide will show you how to set up an integration between dbt Cloud jobs and Microsoft Teams using [dbt Cloud Webhooks](/docs/deploy/webhooks) and Zapier, similar to the [native Slack integration](/docs/deploy/job-notifications#slack-notifications).

When a dbt Cloud job finishes running, the integration will:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: zapier-slack
description: Use Zapier and the dbt Cloud API to post error context to Slack
---

This guide will show you how to set up an integration between dbt Cloud jobs and Slack using [dbt Cloud webhooks](/docs/deploy/webhooks) and Zapier. It builds on the native [native Slack integration](/faqs/accounts/slack) by attaching error message details of models and tests in a thread.
This guide will show you how to set up an integration between dbt Cloud jobs and Slack using [dbt Cloud webhooks](/docs/deploy/webhooks) and Zapier. It builds on the native [native Slack integration](/docs/deploy/job-notifications#slack-notifications) by attaching error message details of models and tests in a thread.

Note: Because there is not a webhook for Run Cancelled, you may want to keep the standard Slack integration installed to receive those notifications. You could also use the [alternative integration](#alternate-approach) that augments the native integration without replacing it.

Expand Down
28 changes: 0 additions & 28 deletions website/snippets/slack-notifications-config-steps.md

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
nghi-ly marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions website/vercel.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
"cleanUrls": true,
"trailingSlash": false,
"redirects": [
{
"source": "/faqs/Accounts/slack",
"destination": "/docs/deploy/job-notifications",
"permanent": true
},
{
"source": "/guides/migration/versions",
"destination": "/docs/dbt-versions/core-upgrade",
Expand Down
Loading