hipchat – Send a message to Hipchat.

From Get docs
Ansible/docs/2.7/modules/hipchat module


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

-

added in 1.6.0

Default:

API url if using a self-hosted hipchat server. For Hipchat API version 2 use the default URI with /v2 instead of /v1.

color

-

  • yellow

  • red
  • green
  • purple
  • gray
  • random

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

-

  • text

  • html

Message format.

notify

boolean

  • no
  • yes

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

added in 1.5.1

  • no
  • yes

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

Authors

  • Shirou Wakayama (@shirou)
  • Paul Bourdel (@pb8226)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


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