Skip to content

Latest commit

 

History

History
132 lines (103 loc) · 3.04 KB

slack.adoc

File metadata and controls

132 lines (103 loc) · 3.04 KB

Valet

Integration with Slack

Before the integration with Slack could be set up a server exposed to the Internet is required. This is done with Ngrok.

Ngrok

Sign up or login to https://ngrok.com. Copy Authtoken from the dashboard.

$ brew install ngrok
$ ngrok config add-authtoken 25vCWkdk[..]xyz
$ ngrok http http://127.0.0.1:8000 --host-header="127.0.0.1:8000"

instead of the last line you can also say ./scripts/ingress in the shell.

The address exposed by Ngrok is used in the Slack integration while creating a new Slack app.

Slack

Go to https://api.slack.com/apps and create a new app from an app manifest. Change the url to the one exposed dynamically by Ngrok.

display_information:
  name: Valet
features:
  app_home:
    home_tab_enabled: true
    messages_tab_enabled: false
    messages_tab_read_only_enabled: true
  bot_user:
    display_name: Valet
    always_online: true
  slash_commands:
    - command: /parking
      url: https://ngrok.io/slack/events
      description: Tell the Valet what to do
      usage_hint: "[command] [args]"
      should_escape: false
oauth_config:
  scopes:
    bot:
      - chat:write
      - commands
      - im:history
      - im:read
      - im:write
      - channels:read
settings:
  event_subscriptions:
    request_url: https://ngrok.io/slack/events
    bot_events:
      - app_home_opened
  interactivity:
    is_enabled: true
    request_url: https://ngrok.io/slack/events
  org_deploy_enabled: false
  socket_mode_enabled: false
  token_rotation_enabled: false

The resource /slack/events is created by default in the Bolt app:

from slack_bolt.async_app import AsyncApp
app = AsyncApp()

def app_factory():
    return app.web_app(path='/slack/events')

You can run the app with a development server:

adev runserver \
    --host 127.0.0.1 --port 8000 \
    --app-factory app_factory \
    bot.py

Security tokens

Credentials are required to connect to Slack. You may need to reinstall the Slack app into the workspace for credentials to be generated and shown.

Go to Your Apps → Basic Information. In App Credentials section you can find Signing Secret.

Go to Your Apps → OAuth & Permissions. In OAuth Tokens for Your Workspace section you can find Bot User OAuth Token.

Either export these in the shell before running the app:

$ export SLACK_SIGNING_SECRET=ab1234
$ export SLACK_BOT_TOKEN=xoxb-cd5678

or pass them while creating an app object:

app = AsyncApp(
    token='xoxb-cd5678',
    signing_secret='ab1234'
)