Notification setup

From Knowledge Base
Revision as of 15:20, 2 July 2024 by Andy (talk | contribs) (Created page with "===Slack Setup=== This must be done by a workspace administrator. #Go to https://api.slack.com/apps #If prompted, sign in to the correct workspace #Click the Create New App button at the top right #Enter an app name ("OnTakt" works just fine) and choose the correct workspace, then click Create App #Under "Add features and functionality", click Incoming Webhooks #Turn on the switch at the top right to activate incoming webhooks #For each channel you want OnTakt to post to...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Slack Setup

This must be done by a workspace administrator.

  1. Go to https://api.slack.com/apps
  2. If prompted, sign in to the correct workspace
  3. Click the Create New App button at the top right
  4. Enter an app name ("OnTakt" works just fine) and choose the correct workspace, then click Create App
  5. Under "Add features and functionality", click Incoming Webhooks
  6. Turn on the switch at the top right to activate incoming webhooks
  7. For each channel you want OnTakt to post to:
    1. Click the Add New Webhook to Workspace button at the bottom
    2. In the page that opens, choose the channel you want to post to and click Allow
    3. Copy the Webhook URL from the list (make sure it's for the right channel)
    4. Paste this URL into the Slack Webhook URL field in the OnTakt machine settings page

To add or remove webhooks in the future:

  1. Go to https://api.slack.com/apps
  2. Click the name of the OnTakt app from the list
  3. Click Incoming Webhooks under Features in the left sidebar

If you would like the app to add an icon to the bot that posts messages:

  1. Go to https://api.slack.com/apps
  2. Click the name of the OnTakt app from the list
  3. Scroll down to Display Information
  4. You can choose any icon, but here is the OnTakt logo
  5. Click + Add App Icon under "App icon & preview" and choose the file

Microsoft Teams Setup

This must be done by a team administrator.

  1. Go to https://teams.microsoft.com/l/app/203a1e2c-26cc-47ca-83ae-be98f960b6b2
  2. Click the "Add to a team" button
  3. Search for the channel you want to send notifications to
  4. Click the "Set up a connector" button
  5. When the configuration page opens, enter any name, such as "OnTakt"
  6. You can choose any icon, but here is the OnTakt logo
  7. Click the "Create" button
  8. After the page reloads, scroll to the bottom and copy the URL it provides
  9. Click "Done"
  10. Paste this URL into the machine's Microsoft Teams Webhook URL field in OnTakt

Email setup

A notification channel can have an email address instead of a webhook URL, however, sending email will not work until an email server is configured. To do this, visit the Notifications tab of the global settings window inside OnTakt and fill in the following fields:

  • Server host: IP address or hostname of the SMTP server.
  • Server port: usually 587 for TLS connections or 25 for unencrypted connections.
  • Secure with TLS: strongly recommended, but requires the SMTP server to support it. SSL is much less secure and therefore not supported.
  • Username: username to log into the SMTP server with.
  • Password: password to log into the SMTP server with.
  • From email address: emails will appear to be from this address. Defaults to the SMTP username if not set.

The correct values for these fields depends on your email provider. Instructions for common providers can be found here:

For accounts with multi-factor authentication enabled, you will need to create and use an app password for OnTakt. Instructions for common providers can be found here:

Note that sending emails is slower than publishing to webhooks, so webhooks are preferred where possible.