community.general.hipchat – Send a message to Hipchat.

Note

This plugin is part of the community.general collection (version 2.5.1).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.hipchat.

Synopsis

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

Parameters

Parameter	Choices/Defaults	Comments
api string	Default: "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 string	Choices: yellow ← red green purple gray random	Background color for the message.
msg string / required		The message body.
msg_format string	Choices: text ← html	Message format.
msg_from string	Default: "Ansible"	Name the message will appear to be sent from. Max length is 15 characters - above this it will be truncated. aliases: from
notify boolean	Choices: no yes ←	If true, a notification will be triggered for users in the room.
room string / required		ID or name of the room.
token string / required		API token.
validate_certs boolean	Choices: no yes ←	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

- name: Send a message to a Hipchat room
  community.general.hipchat:
    room: notif
    msg: Ansible task finished

- name: Send a message to a Hipchat room using Hipchat API version 2
  community.general.hipchat:
    api: https://api.hipchat.com/v2/
    token: OAUTH2_TOKEN
    room: notify
    msg: Ansible task finished

Authors

• Shirou Wakayama (@shirou)

• Paul Bourdel (@pb8226)