hipchat – Send a message to Hipchat
hipchat – Send a message to Hipchat
Synopsis
- Send a message to a Hipchat room, with options to control the formatting.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api - |
Default: |
API url if using a self-hosted hipchat server. For Hipchat API version 2 use the default URI with |
color - |
|
Background color for the message. |
from - |
Default: "Ansible" |
Name the message will appear to be sent from. Max length is 15 characters - above this it will be truncated. |
msg - / required |
The message body. | |
msg_format - |
|
Message format. |
notify boolean |
|
If true, a notification will be triggered for users in the room. |
room - / required |
ID or name of the room. | |
token - / required |
API token. | |
validate_certs boolean |
|
If |
Examples
- hipchat:
room: notif
msg: Ansible task finished
# Use Hipchat API version 2
- hipchat:
api: https://api.hipchat.com/v2/
token: OAUTH2_TOKEN
room: notify
msg: Ansible task finished
Status
- This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
- This module is maintained by the Ansible Community. [community]
Authors
- Shirou Wakayama (@shirou)
- Paul Bourdel (@pb8226)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/hipchat_module.html