Skip to main content

​
Slack Application in Collate

Integrate Collate with Slack to enhance data collaboration and streamline team workflows. This integration enables real-time notifications, in-Slack search and sharing of metadata assets, and message interactions—all within your existing Slack workspace.

​
Overview

The Slack application connects your Slack workspace with Collate, enabling seamless communication and metadata access:
  • Real-Time Notifications: Receive instant alerts, mentions, and updates directly in Slack.
  • Metadata Search: Quickly search for glossaries, terms, tags, and tables within Slack.
  • Asset Sharing: Share Collate assets effortlessly with your team from Slack.
  • Enhanced Productivity: Stay informed and connected without leaving your workspace.

​
Key Capabilities

  • Search Entities: Use Slack to search glossaries, terms, tags, and tables.
  • Share Assets: Share metadata assets from Collate to your team directly in Slack.
  • Notifications: Get notified when someone mentions @<Bot-Name>, or when updates occur in your data workspace.

​
Using Collate in Slack

Once the app is installed, users need to invite it to their channel before they can interact with it.

​
Step 1: Invite the App to a Channel

There are two ways to invite the Collate app to a channel: Option A — From channel settings:
  1. Open the channel in Slack.
  2. Click the channel name at the top to open Channel Settings.
  3. Go to the Integrations tab → Add an App.
  4. Search for your Collate app and click Add.
Option B — Via slash command: In any channel, type: 
/invite @CollateApp
Replace @CollateApp with the name you gave your Slack app during setup.

​
Step 2: Start Asking Questions

Once the app is in your channel, mention it with a natural language query: 
@CollateApp tell me the assets within bigquery service

@CollateApp show tables owned by the marketing team

@CollateApp what are the Tier 1 assets in the warehouse?
Collate AI will respond directly in the channel with relevant metadata from your data platform.
You can also interact with the Collate app in Direct Messages — no channel invite needed.

​
Authorizations

When connected, Collate will have the following permissions in Slack:
  • View and respond to messages that mention @<Bot-Name>.
  • Access content in public channels where Collate is added.
  • Join public channels and view their basic information.
  • Access content in direct messages and group direct messages.
  • View user profiles in the workspace.
  • Send messages as @<Bot-Name>, including to channels it’s not a member of.
  • Post messages to designated Slack channels.

​
Slack App Configuration

To enable Slack integration in Collate:
  1. Navigate to Settings → Applications → Add Apps.
Configuration
  1. Search for Slack and install the application.
Configuration

​
Configuration Fields

  • Client ID: Identifies your Slack app. Required to initiate OAuth flows.
  • Client Secret: Authenticates OAuth requests made by your app.
  • Signing Secret: Verifies that incoming requests originate from Slack.
  • User Token: Authenticates Slack API requests on behalf of a user (starts with xoxp-).
  • Bot Token: Authenticates Slack API requests on behalf of the bot (starts with xoxb-).
Configuration
Store all five credentials securely. Enter them in Collate via Settings → Applications -> Slack Application — do not share tokens directly.

​
How to Obtain Slack Credentials

To integrate Slack with Collate, you need to generate a Bot Token, User Token, Client ID, Client Secret, and Signing Secret from your Slack workspace.

​
Create a Slack App

  1. Go to the Slack API: Your Apps page.
  2. Click Create New App.
Configuration
  1. Select From scratch.
Configuration
  1. Enter the App Name (e.g., Collate Integration) and choose your Slack workspace.
  2. Click Create App.
Configuration
  1. After your app is created, you’ll be redirected to the Basic Information page under Settings. Here, you’ll find the following important credentials:
  • Client ID – Used to identify your app.
  • Client Secret – Used for authenticating requests made from your app.
  • Signing Secret – Used to verify that incoming requests (e.g., from Slack) are genuinely from Slack. Click Show next to each secret to view the values. You can regenerate them using the Regenerate button if needed. Once you have all credentials, enter them in Collate via Settings → Applications.
Make sure to store these securely, as you’ll need them to configure OAuth and validate request signatures later. Basic Information page

​
Configure OAuth & Permissions

  1. In your app’s dashboard, navigate to OAuth & Permissions.
Configuration
  1. Under Scopes, configure the following:
Configuration

​
For Bot Token Scopes:

Add these scopes:
  • app_mentions:read
  • channels:read
  • chat:write
  • commands
  • groups:read
  • im:history
  • im:read
  • mpim:history
  • mpim:read
  • users:read
  • users:read.email

​
For User Token Scopes:

Add these scopes:
  • channels:history
  • groups:history
  • im:history
  • mpim:history
Only add the scopes you need. Ensure your Slack workspace allows user token generation (may require admin privileges).

​
Configure Redirect URLs

Before installing the app to your workspace, configure the redirect URLs to ensure successful OAuth authentication:
  1. In the left-hand menu, go to OAuth & Permissions.
  2. Scroll down to the Redirect URLs section.
  3. Click Add New Redirect URL and enter the redirect URL (e.g., https://sandbox.open-metadata.org/api/slack/callback).
  4. Click Save URLs to apply the changes.
The redirect URL must exactly match the URL used in your OAuth request. This ensures Slack can return the authorization code to your backend after the user grants permissions. Configure Redirect URLs

​
Configure Event Subscriptions

After setting the necessary OAuth scopes, follow the steps below to configure Event Subscriptions:
  1. In the left-hand menu under Features, click on Event Subscriptions.
  2. Toggle the Enable Events switch to On.
Enable Events
  1. In the Request URL field, enter your app’s endpoint (e.g., https://sandbox.open-metadata.org/api/slack/events).
    • Slack will send a verification request containing a challenge parameter.
    • Ensure your endpoint responds with the challenge value to confirm validation.
  2. Scroll down to the Subscribe to bot events section and click Add Bot User Event.
Subscribe to bot events
  • Add the following events (ensure corresponding scopes are already granted under OAuth permissions):
    • app_home_opened – Triggered when a user clicks into your App Home (no additional scope needed).
    • app_mention – Subscribes to messages that mention your app or bot (app_mentions:read scope required).
    • message.im – Subscribes to messages in direct message channels (im:history scope required).
    • message.mpim – Subscribes to messages in multi-party direct message channels (mpim:history scope required).
  1. (Optional) Under Subscribe to events on behalf of users, click Add Workspace Event and select:
    • message.im – Subscribes to messages posted in a direct message channel on behalf of users (im:history scope required).
Slack automatically adds the necessary scopes for any subscribed events if not already included. Subscribe to events on behalf of users

​
Install the App to Workspace

  1. Still in OAuth & Permissions, click Install to install App to your Workspace.
Configuration
  1. Authorize the permissions requested by the app.
After installation, you’ll be redirected to the OAuth screen where your tokens will be displayed.

​
Copy the Tokens

  • Bot User OAuth Token: Starts with xoxb-...
  • User OAuth Token: Starts with xoxp-...
Store these tokens securely and provide them in the Slack app configuration within Collate.
  • Never expose your tokens publicly.
  • Rotate tokens periodically.
  • Use Slack’s token rotation policy for better security.
For more information, refer to the Slack API documentation.