Skip to main content

​
Part 1: Slack Data Ingestion

Set up a Slack app so ConfigView can pull your workspace data (users, channels, user groups) into the dashboard.

​
Step 1: Create a Slack App

  1. Go to: https://api.slack.com/apps
  2. Click Create New App
  3. Choose From scratch
  4. App Name: ConfigView
  5. Pick your workspace from the dropdown
  6. Click Create App

​
Step 2: Add Bot Token Scopes

  1. In the left sidebar, click OAuth & Permissions
  2. Scroll down to Scopes > Bot Token Scopes
  3. Click Add an OAuth Scope and add each of the following:
ScopePurpose
users:readRead workspace member profiles
users:read.emailRead member email addresses
channels:readList public channels
groups:readList private channels the bot is in
usergroups:readList user groups and their members

​
Step 3: Install the App to Your Workspace

  1. Scroll to the top of OAuth & Permissions
  2. Click Install to Workspace
  3. Review the permissions and click Allow
  4. Copy the Bot User OAuth Token (starts with xoxb-)
Keep this token safe. You will add it to ConfigView in the next step.

​
Step 4: Add the Token to ConfigView

  1. Go to your ConfigView dashboard: https://{companyname}.configview.com/admin/secret/
  2. Click Add Secret
  3. Secret name: SLACK_BOT_TOKEN
  4. Secret value: Paste the xoxb-... token you copied
  5. Click Save

​
Step 5: Enable the Slack App in ConfigView

  1. Go to: https://{companyname}.configview.com/admin/app/
  2. You should see Slack in the list of available apps
  3. Select the scripts you want to run:
    • Users — All workspace members with email, admin status, 2FA, timezone
    • Channels — Public and private channels with member counts
    • User Groups — Handle-based groups (e.g. @engineering)
    • User Group Members — Which users belong to which groups
  4. Click Save
Note: User Group Members depends on User Groups. ConfigView handles this automatically — it will always run User Groups first.

​
Step 6: Verify

  1. Go to: https://{companyname}.configview.com/admin/status/
  2. Run the Slack health check
  3. All checks should pass:
    • Secret Manager access
    • Slack API auth
    • users.list scope
    • conversations.list scope
If a check fails, verify:
  • The SLACK_BOT_TOKEN secret is saved correctly (no extra spaces)
  • The bot has been installed to the correct workspace
  • All scopes from Step 2 were added before installing

​
Data Tables

Once the scripts run, the following tables are created:
TableKey Columns
slack_usersslack_user_id, email, real_name, is_admin, has_2fa, deleted
slack_channelschannel_id, name, is_private, is_archived, num_members, creator
slack_user_groupsgroup_id, name, handle, user_count
slack_user_group_membersgroup_id, slack_user_id
All tables include a run_at column for historical tracking.

​
Part 2: Slack Bot (Query Runner)

Run ConfigView queries directly from Slack using the /configview slash command.

​
Step 1: Add Bot Scopes

  1. Go back to: https://api.slack.com/apps
  2. Select your ConfigView app
  3. Go to OAuth & Permissions > Bot Token Scopes
  4. Add the following additional scopes:
ScopePurpose
chat:writePost messages to channels
commandsEnable slash commands
  1. You will be prompted to reinstall the app. Click Reinstall to Workspace and approve.
Important: After reinstalling, the bot token stays the same. You do not need to update the secret in ConfigView.

​
Step 2: (Optional) Add Signing Secret

The signing secret lets ConfigView verify that incoming requests are genuinely from Slack.
  1. In your Slack app settings, go to Basic Information
  2. Scroll to App Credentials
  3. Copy the Signing Secret
  4. In ConfigView, go to https://{companyname}.configview.com/admin/secret/
  5. Add a secret: Name: SLACK_SIGNING_SECRET, Value: paste the signing secret
This is optional but recommended for production use.

​
Step 3: Enable the Slash Command

  1. In the left sidebar, click Slash Commands
  2. Click Create New Command
  3. Fill in:
    • Command: /configview
    • Request URL: https://{companyname}.configview.com/api/slack/command
    • Short Description: Run ConfigView queries
    • Usage Hint: [help | run <query_id>]
  4. Click Save

​
Step 4: Enable Interactivity

This lets users click the “Run” buttons in the query list.
  1. In the left sidebar, click Interactivity & Shortcuts
  2. Toggle Interactivity to On
  3. Set Request URL to: https://{companyname}.configview.com/api/slack/interaction
  4. Click Save Changes

​
Step 5: Invite the Bot to a Channel

  1. Open the Slack channel where you want the bot to post (e.g. #configview-alerts)
  2. Type: /invite @ConfigView
Create a dedicated channel like #configview-alerts to keep query results organized.

​
Step 6: Mark Queries as Slack-Enabled

  1. Go to: https://{companyname}.configview.com/admin/query/
  2. Open a saved query and click Save
  3. Toggle Enable for Slack bot to on
  4. Fill in the Slack summary — this is the description users see when browsing queries in Slack
  5. Click Save

​
Step 7: Test It

  1. Open the Slack channel where the bot was invited
  2. Type: /configview
  3. You should see a list of slack-enabled queries with Run buttons
  4. Click Run on a query — the bot posts the results to the channel
You can also run a query directly by ID: 
/configview run 42
Or get help: 
/configview help

​
Bot Commands

CommandAction
/configviewList all slack-enabled queries with Run buttons
/configview run <id>Run a specific query by ID and post results
/configview helpShow available commands

​
Message Format

The bot posts formatted messages with:
  • Query name as the header
  • Row count summary
  • Table of results (up to 10 rows, 6 columns)
  • Truncation notice if results exceed the display limit

​
Troubleshooting

IssueFix
/configview says “not found”Verify the Slash Command Request URL matches your ConfigView domain
Bot posts nothing on button clickCheck the Interactivity Request URL is correct
”channel_not_found” errorVerify the channel name — no # prefix, exact spelling
”not_in_channel” errorThe bot must be invited to private channels with /invite @ConfigView
”not_authed” or “invalid_auth”Verify SLACK_BOT_TOKEN secret is correct in ConfigView
Query results are emptyCheck that the query works in the ConfigView Query page first
Messages stop after app reinstallToken should persist, but re-check SLACK_BOT_TOKEN if issues occur