Skip to main content

Slack

Zymtrace supports sending notifications to Slack. Currently this only supports sending recommendation notifications.

note

Slack integration requires the worker service to function. See here for how to enable it.

Setup​

  1. Navigate to https://api.slack.com/apps.

  2. Click "Create New App", then "Blank App".

  3. Give the app a name, and select the workspace you want the to recieve messages in.

    note

    The app name is not the name that will be displayed in Slack as the message sender for Zymtrace notifications, but it will still be visible when viewing profile information of the Slack bot.

  4. Click "Continue".

  5. Once the app is created, navigate to "OAuth and Permissions".

  6. Scroll down to "Scopes", and add the following scopes:

  • chat:write: Required for sending messages.
  • chat:write.customize: Required for sending messages with a custom username and avatar. This is used to set the username of the message sender to "Zymtrace", and the profile photo to the Zymtrace logo.
  • chat:write.public: Required for sending messages in public channels. Messages will only be sent in the configured notification channel.

  1. On the same page, scroll up to "OAuth Tokens", click "Install to <your workspace>", then "Allow".

  2. Once the bot has been installed, the page will return back to the app settings page. Note the "Bot User OAuth Token".

  3. In your Slack workspace, right click on the channel you want to receive Zymtrace messages, click on "Channel details" → "View channel details", and then copy the channel ID from the bottom of the modal.

  4. Navigate to your Zymtrace instance's UI and open "Settings" → "Slack".

  5. Enter the configuration:

  • Ensure that "Enabled" is checked.
  • Enter the bot token from step 8. into the "Bot token" field.
  • Enter the channel ID from step 9. into the "Channel" field.
  • Optional: enter the external URL of the Zymtrace UI into the "External web URL" field. If this is provided, the Slack messages will contain a link to the Zymtrace recommendations page.

  1. Save the configuration. A test message will be sent to the channel to check the configuration.

  2. Done!

Note that the Slack integration can be disabled at any time by toggling off "Enabled" on the Slack settings page.