Skip to main content

How to integrate Slack

Who can do this?

You will need to be an admin in Atlan to configure the Slack integration. You will also need inputs and approval from an administrator of your Slack workspace.

To integrate Slack and Atlan, follow these steps.

Retrieve Slack tokens

To retrieve Slack's integration tokens:

  1. Access your Slack apps console at: https://api.slack.com/apps
  2. At the bottom of the page, in the Your App Configuration Tokens box click the Generate Token button.
  3. In the Generate Your App Configuration Token dialog, from the Workspace drop-down choose your Slack workspace and then click the Generate button.
  4. From the Your App Configuration Tokens box:
    1. Under Access Token click the Copy button and save this temporarily.
    2. Under Refresh Token click the Copy button and save this temporarily.
danger

These tokens will usually expire after 12 hours, so will need to be used the same day they are generated.

Connect Atlan to Slack

To connect Atlan to Slack, from within Atlan:

  1. From the left menu, click Admin.
  2. Under Workspace, click Integrations.
  3. In the Slack tile, click the Connect button.
  4. Enter the tokens copied above:
    1. For Access token enter the access token value.
    2. For Refresh token enter the refresh token value.
  5. Click Next to continue.
  6. Under Install the Atlan app in your Slack workspace click the Install now button.
  7. At the bottom of the resulting Slack popup, click the Allow button. (If you want more details on what each permission does, see What does Atlan do with each Slack permission?)

(Optional) Request permission from your Slack admin

If you are not a workspace administrator in Slack, you will be prompted to request permission to install. To request permission to install the integration:

  1. Under Add a message for your App Managers enter an explanation for installing the app.
  2. At the bottom of the form, click the Submit button.
  3. Contact your Slack workspace administrator and ask them to approve the Atlan app.
  4. Once approved, you'll get an alert in Slack from Slackbot.
  5. Once you receive the Slackbot alert, return to the Integrations menu in Atlan (in the Admin Center) and click the Add to Slack button.

Atlan is now connected to Slack! 🎉

Configure integration from Atlan to Slack

To configure the Slack integration from Atlan, from the Integrations sub-menu:

  1. Expand the Slack tile.
  2. Under the Configurations tab, enter channels to use in your Slack workspace. Enter the channel name or provide a link to the channel without a #, and press tab or enter after each channel to add multiple channels.
    1. (Optional) For Channels, add any channels that users should be able to post to from within Slack or get notified on glossary updates.
    2. (Optional) For Announcements channel, enter the name of a single channel that can be used to view announcements on assets in Atlan.
    3. (Optional) For Workflows alert channel, enter the name of a single channel that can be used to view alerts for workflow activities in Atlan. You can also choose to receive failure alerts only by toggling on the Receive failure alerts only slider.
    4. (Optional) For Playbooks alert channel, enter the name of a single channel that can be used to view alerts for playbook runs in Atlan. You can also choose to receive failure alerts only by toggling on the Receive failure alerts only slider.
    5. (Optional) For Query output share channels, add any channels where users should be able to share query output.
    6. (Optional) For Request notifications, toggle on the slider to receive Slack notifications when requests are raised in Atlan and approve or reject them directly from Slack.
  3. At the bottom of the tile, click the Update button.

Users can now post to Slack without leaving Atlan! 🎉

Did you know?

Channels need to be public for Atlan to be able to post to them. If you try to integrate a private channel you will see an error for that channel when you try to update.

Configure integration from Slack to Atlan

To configure the Atlan integration from Slack, from within Slack:

  1. Open each channel you want Slack users to be able to query Atlan from within.
  2. At the top of the channel, click the name of the channel.
  3. Change to the Integrations tab.
  4. In the Apps tile, click the Add an app button.
  5. Find the Atlan app under the In your workspace heading and click the Add button next to it.
  6. (Optional) To add an icon to the Atlan app in Slack, from the Apps page, click the Atlan app. On the Display Information page, under App icon & Preview, click + Add App Icon and upload the Atlan icon for the app. 

Users can now search for assets in Atlan without leaving Slack! 🎉

Did you know?

You can even add the Atlan app to private channels.