Skip to main content

Default OAuth v2 App

Overview​

OAuth allows a user in any Slack workspace to install your app. At the end of the OAuth flow, your app gains an access token. Your app's access token opens the door to Slack API methods, events, and interactive features.

This connection mode does not require any preparation by project owners, but it depends on a preexisting AutoKitteh server-wide configuration.

If you want to use your own OAuth v2 app in your project(s), see the Private OAuth guide.

If you want to use your own Socket Mode app in your project(s), see the Socket Mode guide.

note

This guide assumes that the AutoKitteh server is already configured with HTTP tunneling.

Slack Documentation​

Background information: installing Slack apps with OAuth.

Create a Slack App​

  1. Click here: create a Slack app

  2. Select the option "From a manifest"

  3. Pick a workspace to develop the app in, and click the green "Next" button

  4. Switch from JSON to YAML

  5. Replace the default app manifest with this:

display_information:
  name: AutoKitteh Demo App
features:
  bot_user:
    display_name: AutoKitteh
    always_online: true
  slash_commands:
    - command: /COMMAND-NAME
      url: https://PUBLIC-AK-ADDRESS/slack/command
      description: Send command to AutoKitteh
      should_escape: true
oauth_config:
  redirect_urls:
    - https://PUBLIC-AK-ADDRESS/oauth/redirect/slack
  scopes:
    bot:
      - app_mentions:read
      - bookmarks:read
      - bookmarks:write
      - channels:history
      - channels:manage
      - channels:read
      - chat:write
      - chat:write.customize
      - chat:write.public
      - commands
      - dnd:read
      - groups:history
      - groups:read
      - groups:write
      - im:history
      - im:read
      - im:write
      - mpim:history
      - mpim:read
      - mpim:write
      - reactions:read
      - reactions:write
      - usergroups:read
      - usergroups:write
      - users.profile:read
      - users:read
      - users:read.email
settings:
  event_subscriptions:
    request_url: https://PUBLIC-AK-ADDRESS/slack/event
    bot_events:
      - app_home_opened
      - app_mention
      - app_uninstalled
      - channel_archive
      - channel_created
      - channel_deleted
      - channel_id_changed
      - channel_left
      - channel_rename
      - channel_shared
      - channel_unarchive
      - channel_unshared
      - group_archive
      - group_deleted
      - group_left
      - group_rename
      - group_unarchive
      - member_joined_channel
      - member_left_channel
      - message.channels
      - message.groups
      - message.im
      - message.mpim
      - reaction_added
      - reaction_removed
      - tokens_revoked
  interactivity:
    is_enabled: true
    request_url: https://PUBLIC-AK-ADDRESS/slack/interaction
  org_deploy_enabled: false
  socket_mode_enabled: false
  token_rotation_enabled: false

Edit these details within the app manifest:

  • display_information.name
  • features.bot_user.display_name
IMPORTANT

You must also replace all the instances of the string PUBLIC-AK-ADDRESS within the app manifest with the AutoKitteh server's public tunnel address:

  • features.slash_commands[*].url
  • oauth_config.redirect_urls[0]
  • settings.event_subscriptions.request_url
  • settings.interactivity.request_url

You must also replace the string COMMAND-NAME within the app manifest with the app's actual slash command name:

  • features.slash_commands[*].command
WARNING

Slash command names must be unique within a Slack workspace, do not install more than one Slack app with the same slash command name!

This is because Slack sends slash command events only to the last-installed app which declared that slash command, not all of them.

TIPS

Slash commands are an optional feature - you may remove the one in the template, or add multiple ones.

Scopes are permissions that your app requires:

  • The template above includes a wide range of them - you may add and remove any based on your functional and security needs
  • However, do not remove the users:read scope! (AutoKitteh requires it during connection initializations)
  • Also, do not remove the commands scope if you use slash commands!
  • For more details on Slack scopes, see: granular bot permission scopes

Bot events are asynchronous notifications that your app subscribes to receive:

  • The template above includes a wide range of them - you may remove any based on your functional needs
  • Contact us if you need to add new events that AutoKitteh does not support yet

  1. Click the green "Next" button

  2. Click the green "Create" button

Install the Slack App​

  1. Click the green "Install to Workspace" button

  2. Click the green "Allow" button

Post-Creation Settings​

  1. In the app's "Basic Information" page, scroll down to the "App Credentials" section

  2. Make a note of the following details for later:

    • Client ID
    • Client Secret (click the "Show" button next to it)
    • Signing Secret (click the "Show" button next to it)

  3. Click "App Home" under "Features" in the left sidebar

  4. Scroll down the page to the "Show Tabs" section, and check the checkbox "Allow users to send Slash commands and messages from the messages tab"

    This is optional, but recommended for a better user experience.

AutoKitteh Server​

There are two equivalent options to configure the AutoKitteh server to interact with a Slack OAuth v2 app - choose the one most suited for your needs and constraints.

For more details, see the Configuration Methods page.

Lastly, restart the AutoKitteh server for these settings to take effect.

Environment Variables​

Set this environment variable, based on the AutoKitteh server's public tunnel address:

  • WEBHOOK_ADDRESS
    • Just the address, without the https:// prefix, and without a path suffix

Also set these environment variables, based on the values you copied in the Post-Creation Settings section above:

  • SLACK_CLIENT_ID
  • SLACK_CLIENT_SECRET
  • SLACK_SIGNING_SECRET

config.yaml File​

Will be implemented soon. Stay tuned!

AutoKitteh Connections​

When you create, initialize, or edit the connection in an AutoKitteh project:

  1. Select the "Slack" connection type, if not selected yet

  2. Select the "Default OAuth v2 app" authentication type, if not selected yet

  3. Click the "Start OAuth Flow" button