diff options
| author | Jeandre Le Roux <theblazehen@theblazehen.com> | 2018-03-21 09:02:50 +0100 |
|---|---|---|
| committer | Jeandre Le Roux <theblazehen@theblazehen.com> | 2018-03-21 09:02:50 +0100 |
| commit | fd12c44adad86d3951f561c66966dd7950c2e69e (patch) | |
| tree | b55f9be1747d2246e92dec6e7c5a34708371e991 /docs | |
| parent | Merge pull request #1623 from cvick/patch-1 (diff) | |
| download | awx-fd12c44adad86d3951f561c66966dd7950c2e69e.tar.xz awx-fd12c44adad86d3951f561c66966dd7950c2e69e.zip | |
Add Rocket.Chat notification type
Summary: Add Rocket.Chat notification type
Issue type: Feature Pull Request
Component: Notifications
Signed-off-by: Jeandre Le Roux <theblazehen@theblazehen.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/notification_system.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/notification_system.md b/docs/notification_system.md index 43942db548..b2fcd0d662 100644 --- a/docs/notification_system.md +++ b/docs/notification_system.md @@ -36,6 +36,7 @@ The currently defined Notification Types are: * Slack * Hipchat * Mattermost +* Rocket.Chat * Pagerduty * Twilio * IRC @@ -126,6 +127,26 @@ In order to enable these settings in Mattermost: * Utilize an existing Mattermost installation or use their docker container here: `docker run --name mattermost-preview -d --publish 8065:8065 mattermost/mattermost-preview` * Turn on Incoming Webhooks and optionally allow Integrations to override usernames and icons in the System Console. +## Rocket.Chat + +The Rocket.Chat notification integration uses Incoming Webhooks. A password is not required because the webhook URL itself is the secret. An integration must be created in the Administration section of the Rocket.Chat settings. + +The following fields are available for the Rocket.Chat notification type: +* `url`: The incoming webhook URL that was configured in Rocket.Chat. Notifications will use this URL to POST. +* `username`: Optional. Change the displayed username from Rocket Cat to specified username +* `icon_url`: Optional. A URL pointing to an icon to use for the notification. + +### Testing considerations + +* Make sure that all options behave as expected +* Test that all notification options are obeyed + +### Test Service + +* Utilize an existing Rocket.Chat installation or use their docker containers from https://rocket.chat/docs/installation/docker-containers/ +* Create an Incoming Webhook in the Integrations section of the Administration settings + + ## Pagerduty Pager duty is a fairly straightforward integration. The user will create an API Key in the pagerduty system (this will be the token that is given to Tower) and then create a "Service" which will provide an "Integration Key" that will be given to Tower also. The other options of note are: |