Skip to content

Latest commit

 

History

History
86 lines (49 loc) · 2.96 KB

slack-integration.md

File metadata and controls

86 lines (49 loc) · 2.96 KB
description
Learn steps to set up Slack notifications for on-prem installations. To use Aviator's Slack notifications, you will need to set up and connect a Slack app.

Slack Integration for On-Premise

There are extra steps for the on-prem installations in order to use Slack Integration.

Create your Slack App

To use Aviator’s Slack notifications, your team will need to set up a Slack app. Follow the steps below.

Set up app credentials

Navigate to Basic Information. Here you will find the information that allows your app to access the Slack API.

You’ll also need to add info for your GitHub app. Find it under General > About and Client secrets at the top of your app page.

Set the following environment variables:

SLACK_APP_ID = "..."
SLACK_CLIENT_ID = "..."
SLACK_CLIENT_SECRET = "..."
SLACK_SIGNING_SECRET = "..."

GITHUB_CLIENT_ID = "..."
GITHUB_CLIENT_SECRET = "..."

Feel free to set an app icon for Aviator in Display Information.

OAuth and Permissions

Redirect URL

Set up a redirect URL: https://<your_domain>/internal/api/slack/oauth/finish

Setup your OAuth redirect URL.

Scopes

Select the following Bot Token Scopes: chat:write, chat:write.public, commands, im:write. Please make sure to set these correctly, they are required for the Slack OAuth flow.

Add bot scopes.

Add slash commands

Create the following slash command, it will link a user’s Slack account with their Aviator activity on GitHub so individuals can receive DMs about their own PRs.

Command: /aviator

Request URL: https://<your_domain>/slack/slash_command

Short Description: connect your Slack account

Usage Hint: connect

Add the slash commands.

Add in Slack Home Page

In your app config navigate to Features -> Event Subscriptions.

Enable Event Subscriptions

Set up a request URL: https://<your_domain>/slack/events

Subscribe to bot events

Select the following bot events to subscribe to: app_home_opened

Enable bot events

Enable Home Tab

In Features -> App Homeenable the App Home's Home Tab.

Enable the Home Tab

Connect the App

Follow the instructions here to connect the app to your account and get notifications: Slack Integration.