Add a Slack data source

1. Click Settings/Data Sources.

2. Select HCP Vault Radar Scan.

3. Under Team Collaboration, click Slack.

4. Click Connect to Slack to install the Slack app. This initiates the OAuth flow with Slack.

5. Select the Slack workspace from the dropdown list and click Allow

   Permission required to install Slack app

   If you do not have permission to install apps into the selected workspace, you will see a Submit Request button instead of the Allow button.

   Coordinate with your Slack workspace administrator to approve the app installation.

   HCP Vault Radar displays the message Authenticated to Slack.

6. Click Next.

7. Select either All active channels or Select channels to monitor.

   The onboarding workflow joins the Slack app to the selected channels. If you have a large number of channels, this process will take several minutes to complete.

8. Click Finish to start onboarding and scanning the selected channels.

The Vault Radar agent scan integrates with Slack using a self-created Slack app. You create the Slack app before adding Slack as a data source in Vault Radar.

Learn more about the HCP Vault Radar agent in the HCP Vault Radar operations tutorials.

Create a Slack app

1. Log into Slack with an account that has permission to create apps in your workspace.

2. Navigate to api.slack.com/apps.

3. Click Create New App.

4. Click From a manifest.

5. Select the workspace where you want to install the app and click Next.

6. Click the YAML tab.

7. Enter the following manifest, replacing YOUR_PROJECT_ID with your HCP project ID and YOUR_WORKSPACE_NAMEwith your Slack workspace ID on line 26.

   display_information:
     name: Vault Radar Integration
     description: Slack integration for HashiCorp Vault Radar
     background_color: "#FFFFFF"
   
   features:
     bot_user:
       display_name: Vault Radar Bot
       always_online: true
   
   oauth_config:
     scopes:
       bot:
         - channels:history
         - channels:join
         - channels:read
         - users:read
         - users:read.email
   
   settings:
     event_subscriptions:
       request_url: https://api.cloud.hashicorp.com/2023-05-01/vault-radar/projects/YOUR_PROJECT_ID/api/webhook-events/code-servers/slack-cloud?org=YOUR_WORKSPACE_NAME
       bot_events:
         - app_uninstalled
         - channel_archive
         - channel_created
         - channel_deleted
         - channel_left
         - channel_rename
         - channel_unarchive
         - message.channels
     org_deploy_enabled: false
     socket_mode_enabled: false
     token_rotation_enabled: false
   

8. Click Next.

9. Review the app configuration and click Create.

Enable OAuth and gather tokens

1. Log into the HCP Portal with a user that has permission to configure Vault Radar data sources.

2. Navigate to OAuth & Permissions.

3. Click Install to Your Workspace, a new page opens.

4. Click Allow.

5. Copy the Bot User OAuth Token.

6. Set an environment variable on the agent host to store the OAuth token.

   Example shell command:

   export SLACK_OAUTH="xoxb-xxxxxxxxxx-xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"
   

7. Navigate back to Basic Information

8. Copy the Signing Secret and store it securely. You will use this secret to configure Vault Radar.

   The Slack app is ready to connect to Vault Radar.

Add Slack data source

1. Click Settings and select Data Sources.

2. Select HCP Vault Radar Agent Scan.

3. Under Team Collaboration, click Slack.

4. Enter the following information:

   • Enter your Slack workspace name: The name of the Slack workspace where you created the Slack app in the previous section.

   • Enter environment path to your Slack user OAuth token: The environment variable name where stored the Slack OAuth token on the agent host.

   Example:

   env://SLACK_OAUTH
   

   • Enter your Slack signing secret: The signing secret copied from the Slack app configuration page.

5. Click Next.

6. Select either All active channels or Select channels to monitor.

7. Click Finish to start onboarding and scanning the selected channels.

Verify the app for event listening

Return to the Slack app configuration page to verify that the app is properly configured to listen for events.

1. Select Event Subscriptions from the app management page

2. Verify the Request URL displays Verified

   Note

   If you see the message Your URL didn't respond, next to the Request URL, click Retry.