community.general.hipchat module – Send a message to Hipchat
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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.
Aliases: notification.hipchat
Parameters
Parameter |
Comments |
---|---|
API url if using a self-hosted hipchat server. For Hipchat API version 2 use the default URI with Default: |
|
Background color for the message. Choices:
|
|
The message body. |
|
Message format. Choices:
|
|
Name the message will appear to be sent from. Max length is 15 characters - above this it will be truncated. Default: |
|
If true, a notification will be triggered for users in the room. Choices:
|
|
ID or name of the room. |
|
API token. |
|
If Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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