ansible.builtin.hipchat (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hipchat:
    room: notif
    msg: Ansible task finished

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Use Hipchat API version 2
- hipchat:
    api: https://api.hipchat.com/v2/
    token: OAUTH2_TOKEN
    room: notify
    msg: Ansible task finished

Inputs

    
api:
    default: https://api.hipchat.com/v1
    description:
    - API url if using a self-hosted hipchat server. For Hipchat API version 2 use the
      default URI with C(/v2) instead of C(/v1).
    version_added: 1.6.0
    version_added_collection: ansible.builtin

msg:
    description:
    - The message body.
    required: true

from:
    default: Ansible
    description:
    - Name the message will appear to be sent from. Max length is 15 characters - above
      this it will be truncated.

room:
    description:
    - ID or name of the room.
    required: true

color:
    choices:
    - yellow
    - red
    - green
    - purple
    - gray
    - random
    default: yellow
    description:
    - Background color for the message.

token:
    description:
    - API token.
    required: true

notify:
    default: 'yes'
    description:
    - If true, a notification will be triggered for users in the room.
    type: bool

msg_format:
    choices:
    - text
    - html
    default: text
    description:
    - Message format.

validate_certs:
    default: 'yes'
    description:
    - If C(no), SSL certificates will not be validated. This should only be used on personally
      controlled sites using self-signed certificates.
    type: bool
    version_added: 1.5.1
    version_added_collection: ansible.builtin