Mattermost

Authentication

  1. Use https://<impulse_domain>/auth/callback as ENV AUTH_REDIRECT_URL↰
  2. Go to menu (3×3 dots) > System Console > Integrations > OAuth 2.0 Applications, click Add OAuth 2.0 Application:
    • set parameters:
      • set "Is Trusted" to No
      • set "Is Public Client" to No
      • set "Display Name" to IMPulse OAuth
      • set "Description" to -
      • set "Homepage" to the same as messenger.impulse_address
      • set "Callback URLs" same as AUTH_REDIRECT_URL↰
    • press Save
    • use "Client ID" as ENV AUTH_CLIENT_ID↰
    • use "Client Secret" as ENV AUTH_CLIENT_SECRET↰
    • press Done

Create a bot

  1. Go to menu (3×3 dots) > System Console > Integrations > Bot Accounts:

    • set Enable Bot Account Creation to True and press Save

  2. Go to menu (3×3 dots) > Integarations > Bot Accounts:

    • click Add Bot Account
    • set Username to "impulse"
    • optionally set our logo as the Bot Icon
    • set Display Name to "IMPulse"
    • set Role to "System Admin"
    • click Create Bot Account
    • copy the "Token" and use it as the MATTERMOST_ACCESS_TOKEN↰ environment variable (see step 2.3 here)
    • click Done

Configure the bot

  1. Go to menu (3×3 dots) > System Console > User Management > Teams:
    • press on your Team
    • press the button Add Members
    • type "impulse" in search, select it and press the button Add
    • press the button Save

Configure channels

  1. To use IMPulse bot in private channels you must add it manually. Run this command in all necessary private channels:

    /invite @impulse

  2. Users listed in messenger.admin_users↰ must be present in all channels defined in route↰.

  3. Users mentioned in messenger.chains↰ should be added to their respective channels.

  4. We recommend configuring IMPulse channels for all messenger.users↰ as follows:

    • select the channel in main list and press on it
    • click the View Info icon (i) in the top right, click Notifications Preferences
    • in the "Notify me about..." choose "Mentions, direct messages, and keywords only"
    • click Save.

Get group ID

MATTERMOST_URL="<your_mattermost_address>"
MATTERMOST_ACCESS_TOKEN="<your_mattermost_bot_token>"
curl -s -H "Authorization: Bearer $MATTERMOST_ACCESS_TOKEN" "$MATTERMOST_URL/api/v4/groups"

Get user ID

Instruction

MATTERMOST_URL="<your_mattermost_address>"
MATTERMOST_ACCESS_TOKEN="<your_mattermost_bot_token>"
curl -s -H "Authorization: Bearer $MATTERMOST_ACCESS_TOKEN" "$MATTERMOST_URL/api/v4/users/username/<username_without_@>" | jq .id