W3cubDocs

/Ansible

hipchat - Send a message to hipchat.

Synopsis

Send a message to hipchat

Options

parameter required default choices comments
api
(added in 1.6.0)
 no https://api.hipchat.com/v1
API url if using a self-hosted hipchat server. For hipchat api version 2 use /v2 path in URI
color
 no yellow
  • yellow
  • red
  • green
  • purple
  • gray
  • random
Background color for the message. Default is yellow.
from
 no Ansible
Name the message will appear be sent from. max 15 characters. Over 15, will be shorten.
msg
 yes
The message body.
msg_format
 no text
  • text
  • html
message format. html or text. Default is text.
notify
 no yes
  • yes
  • no
notify or not (change the tab color, play a sound, etc)
room
 yes
ID or name of the room.
token
 yes
API token.
validate_certs
(added in 1.5.1)
 no yes
  • yes
  • no
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

- hipchat:  room=notify 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"

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/hipchat_module.html