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

Send BearyChat notifications

| "added in version" 2.4 of ansible.builtin"

Authors: Jiangge Zhang (@tonyseek)

stableinterface | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

The M(bearychat) module sends notifications to U(https://bearychat.com) via the Incoming Robot integration.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Send notification message via BearyChat
  local_action:
    module: bearychat
    url: |
      https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60
    text: "{{ inventory_hostname }} completed"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Send notification message via BearyChat all options
  local_action:
    module: bearychat
    url: |
      https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60
    text: "{{ inventory_hostname }} completed"
    markdown: no
    channel: "#ansible"
    attachments:
      - title: "Ansible on {{ inventory_hostname }}"
        text: "May the Force be with you."
        color: "#ffffff"
        images:
          - http://example.com/index.png

Inputs

    
url:
    description:
    - BearyChat WebHook URL. This authenticates you to the bearychat service. It looks
      like C(https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60).
    required: true

text:
    description:
    - Message to send.

channel:
    description:
    - Channel to send the message to. If absent, the message goes to the default channel
      selected by the I(url).

markdown:
    default: 'yes'
    description:
    - If C(yes), text will be parsed as markdown.
    type: bool

attachments:
    description:
    - Define a list of attachments. For more information, see https://github.com/bearyinnovative/bearychat-tutorial/blob/master/robots/incoming.md#attachments

Outputs

msg:
  description: execution result
  returned: success
  sample: OK
  type: str