Skip to content

Commit

Permalink
Slack move to OAuth (#5241)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

Updating the Slack integration instructions to reflect new workflows and
breaking it out as an individual page.

## Checklist
<!--
Uncomment when publishing docs for a prerelease version of dbt:
- [ ] Add versioning components, as described in [Versioning
Docs](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-entire-pages)
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade)
-->
- [ ] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [ ] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [ ] Add a checklist item for anything that needs to happen before this
PR is merged, such as "needs technical review" or "change base branch."

Adding or removing pages (delete if not applicable):
- [ ] Add/remove page in `website/sidebars.js`
- [ ] Provide a unique filename for new pages
- [ ] Add an entry for deleted pages in `website/vercel.json`
- [ ] Run link testing locally with `npm run build` to update the links
that point to deleted pages
  • Loading branch information
matthewshaver authored Apr 16, 2024
2 parents ead5840 + 2c07bcc commit 42499b0
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions website/docs/docs/deploy/job-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You can receive email alerts about jobs by configuring the dbt Cloud email notif

## Slack notifications

You can receive Slack alerts about jobs by setting up the Slack integration, then configuring the dbt Cloud Slack notification settings.
You can receive Slack alerts about jobs by setting up the Slack integration, then configuring the dbt Cloud Slack notification settings. dbt Cloud integrates with Slack via OAuth to ensure secure authentication.

:::note
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.
Expand All @@ -52,16 +52,28 @@ If there has been a change in user roles or Slack permissions where you no longe
### 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).
- Make sure the notification channel (where you want to receive alerts) is a public channel. The integration only supports public channels in the Slack workspace.
- The integration only supports _public_ channels in the Slack workspace.

### 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**.
1. From the gear menu, select **Account settings** and then select **Integrations** from the left sidebar.
1. Locate the **OAuth** section with 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.

### Logged in to Slack
If you're already logged in to Slack, the handshake only requires allowing the app access. If you're 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"/>

## Logged out

If you're logged out or the Slack app/website is closed, you must authenticate before completing the integration.

1. Complete the field defining the Slack workspace you want to integrate with dbt Cloud.
<Lightbox src="/img/docs/dbt-cloud/define-workspace.png" width="75%" title="Define the workspace"/>
2. Sign in with an existing identity or use email address and password.
3. Once you have authenticated successfully, accept the permissions.
<Lightbox src="/img/docs/dbt-cloud/accept-permissions.png" width="75%" title="Allow dbt access to Slack"/>

### Configure Slack notifications

1. From the gear menu, choose **Notification settings**.
Expand All @@ -80,5 +92,5 @@ If there has been a change in user roles or Slack permissions where you no longe

### 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.
1. From the gear menu, select **Account settings**. On the **Integrations** page, scroll to the **OAuth** section.
1. Click the trash can icon (on the far right of the Slack integration) and click **Unlink**. Channels that you configured will no longer receive Slack notifications. _This is not an account-wide action._ Channels 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 their configuration.
Binary file modified website/static/img/docs/dbt-cloud/Link-your-Slack-Profile.png
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.

0 comments on commit 42499b0

Please sign in to comment.