Integration: Slack

To integrate DeepSource with Slack you need a Slack application. This document outlines the configuration, permission requirements and app configuration to get started with it.

Creating the Slack app

To create the app, you can run this quick setup script with a few additional steps. The script will create a Slack app manifest that can be used to easily create a Slack app.

python3 <(curl -s https://raw.githubusercontent.com/deepsourcelabs/enterprise-assets/master/integrations/create_slack_app.py)
  1. When you run the command in the CLI, a few details will have to filled in:

    • Name for the Slack app: The name of the Slack app being created. Defaults to DeepSource Enterprise.
    • The URL of your DeepSource installation: The URL of your DeepSource instance. For e.g., if your DeepSource instance is running on https://deepsource.stark.com, then enter https://deepsource.stark.com here.
  2. Copy the slack app manifest.

    Create Slack App Script

  3. Goto https://api.slack.com/apps and log into the Slack Developer Console if required.

  4. Click on Create New App.

  5. In the popup that opens select From an app manifest.

  6. Select the Slack workspace you'd like to create the app under and click on Next.

  7. Select the YAML tab and paste the app manifest. Once done, click on Next.

    Jira app authorization

  8. Click on Create.

  9. Scroll down and navigate to the "App Credentials" section and note down the following values:

    • Client ID
    • Client Secret
    • Signing Secret

    Jira app settings

Configuring the Slack app in the Admin Console

After you create your Jira Cloud application, you need to configure Client ID & Secret in the Admin Console for the application to use it.

  1. Visit the Admin Console
  2. Navigate to Application -> Config.
  3. In the Integrations section, set "Enable Integrations" to "Yes" and select the "Slack" checkbox.
  4. Fill up the values from the previous step for:
    1. Slack Integration Client ID
    2. Slack Integration Client Secret
    3. Slack Integration Signing Secret
  5. Save.

Jira configuration on Admin Console