Documentation

hipchat - Send a message to Hipchat.

Synopsis

  • Send a message to a Hipchat room, with options to control the formatting.

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 the default URI with /v2 instead of /v1.
color
no yellow
  • yellow
  • red
  • green
  • purple
  • gray
  • random
Background color for the message.
from
no Ansible
Name the message will appear to be sent from. Max length is 15 characters - above this it will be truncated.
msg
yes
The message body.
msg_format
no text
  • text
  • html
Message format.
notify
no yes
  • yes
  • no
If true, a notification will be triggered for users in the room.
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: 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 flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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