diff options
| author | Nicholas O. Wilburn <senior.crepe@gmail.com> | 2017-09-15 00:44:54 +0200 |
|---|---|---|
| committer | Nicholas O. Wilburn <senior.crepe@gmail.com> | 2017-09-15 03:25:01 +0200 |
| commit | cd3ba08c7de785797a1088533320d44981ab56a7 (patch) | |
| tree | b6ba5505a5635e47fde9918566782661079c59e8 | |
| parent | Remove unnecessary fields from mattermost notification UI files (diff) | |
| download | awx-cd3ba08c7de785797a1088533320d44981ab56a7.tar.xz awx-cd3ba08c7de785797a1088533320d44981ab56a7.zip | |
Update mattermost notification docs with examples
| -rw-r--r-- | docs/notification_system.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/notification_system.md b/docs/notification_system.md index cf0c9a53d8..43942db548 100644 --- a/docs/notification_system.md +++ b/docs/notification_system.md @@ -102,7 +102,13 @@ https://www.hipchat.com/server ## Mattermost -The mattermost notification integration uses Incoming Webhooks. These must be enabled in the System Console of Mattermost. If the user wishes to allow Ansible Tower notifications to modify the Icon URL and username of the notification then they must enabled these options as well. +The mattermost notification integration uses Incoming Webhooks. A password is not required because the webhook URL itself is the secret. Webhooks must be enabled in the System Console of Mattermost. If the user wishes to allow Ansible Tower notifications to modify the Icon URL and username of the notification then they must enabled these options as well. + +In order to enable these settings in Mattermost: +1. First go to System Console > Integrations > Custom Integrations. Check Enable Incoming Webhooks +2. Optionally, go to System Console > Integrations > Custom Integrations. Check "Enable integrations to override usernames" and Check "Enable integrations to override profile picture icons" +3. Go to Main Menu > Integrations > Incoming Webhook. Click "Add Incoming Webhook" +4. Choose a "Display Name", "Description", and Channel. This channel will be overridden if the notification uses the `channel` option * `url`: The incoming webhook URL that was configured in Mattermost. Notifications will use this URL to POST. * `username`: Optional. The username to display for the notification. |