Slack

Steps to configure your Atlan Slack app

What is the Slack app all about?

The Atlan Slack app in your workspace will get you rich previews of Atlan links that are shared on Slack channels.

Table view
Column view
Dashboard view
Integration view

๐Ÿ‘€ Note: If your Atlan instance is on a VPN, then the Slack app will not work.

๐Ÿ“œ Prerequisites for the Slack app

Anyone can configure the Slack app end-to-end. However, you'll need someone with admin access to Slack who can install the Atlan app into your Slack workspace.

๐Ÿš€ How to add the Atlan app in your Slack

โœจ Spotlight: Want to learn more about creating, managing, and building Slack apps? Check out Slack's in-depth resources.

STEP 1: Creating a Slack app

  1. Go to the Slack API.

  2. Enter "Atlan" as the app name.

  3. Select your organization's workspace from the drop-down menu.

STEP 2: Set up event subscriptions

  1. Go to the "Event Subscriptions" tab for the Slack app you've just created.

  2. Turn on the toggle for "Enable events".

  3. Under "Subscribe to bot events", add a "link_shared" event.

  4. Under "App unfurl domains", add your organization's Atlan link. It might look something like atlan.mycoolorg.com. Then click on "Done".

  5. Click on the "Save changes" button at the bottom.

STEP 3: Set up the basic Slack app information

  1. Go to the "Basic Information" tab in your Slack app console.

  2. Go to the "Display Information" section.

  3. Add the description as "Home for data teams".

  4. Add "#2026d2" for the background color.

  5. Add the Atlan logo for the app icon. You can download the Atlan logo here.

STEP 4: Install the Slack app

  1. Go to "Install app" from the sidebar in your Slack app console.

  2. Click the "Request to Install" button.

  3. Ask your organization's IT admin to accept the request to install the Atlan app in Slack.

  4. After the request has been approved, you will see an "Install to workspace" button. Click this button.

Install the Atlan App
  1. Click "Allow".

  2. Copy the Bot User OAuth Access Token and keep it in a notepad. You will need this later.

  3. Go to any of your Slack channels, and add the Atlan app you just created in the channel.

Add Atlan app
  1. Add the Atlan app from the apps list.

Atlan app

STEP 5: Adding Slack environment variables in Atlan

  1. Go to the "Basic Information" tab in your Slack app console.

  2. Go to the "App Credentials" section. You'll need to copy credentials from here.

  3. In a separate tab, go to your Atlan release portal, and open the "Atlan Slack App Credentials" section.

  4. For "Slack Verification Token", add the Verification Token from Slack.

  5. For the "Slack OAuth Token", add the Bot User OAuth Token from Slack.

Atlan release portal
  1. Click the "Save Config" button at the bottom of the page.

  2. Once you see a prompt saying the config has been updated, click on "Go to new version".

๐Ÿ‘€ Note: If you don't see the prompt manually, select the "Version History" tab in the release portal.

New version prompt
  1. Deploy the latest release on the release page.

Wait for a few minutes as the release deploys. Brew yourself a cup of coffee while it happens โ˜•

STEP 6: Set up Slack events

  • Go to the "Event Subscriptions" tab for the Slack app you've just created.

  • Make sure the Enable events toggle is on.

  • In "Request URL" field add https://{your\_atlan\_instance\_url}/api/metadata/tenants/default/slack/onevent. (For example, the URL could look like this: https://atlan.mycoolorg.com/api/metadata/tenants/default/slack/onevent.)

Slack enable event
  • You will see a verified checkmark after adding the URL.

  • Click on the "Save changes" button at the bottom.

๐Ÿ˜Œ After you complete these steps, try sharing an Atlan link inside the channel where you added the Slack app. Slack should unfurl the Atlan links!