community.general.bearychat module – Send BearyChat notifications
Note
This module is part of the community.general collection (version 5.8.3).
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.bearychat
.
Synopsis
The community.general.bearychat module sends notifications to https://bearychat.com via the Incoming Robot integration.
Parameters
Parameter |
Comments |
---|---|
Define a list of attachments. For more information, see https://github.com/bearyinnovative/bearychat-tutorial/blob/master/robots/incoming.md#attachments |
|
Channel to send the message to. If absent, the message goes to the default channel selected by the url. |
|
If Choices:
|
|
Message to send. |
|
BearyChat WebHook URL. This authenticates you to the bearychat service. It looks like |
Examples
- name: Send notification message via BearyChat
local_action:
module: bearychat
url: |
https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60
text: "{{ inventory_hostname }} completed"
- 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: false
channel: "#ansible"
attachments:
- title: "Ansible on {{ inventory_hostname }}"
text: "May the Force be with you."
color: "#ffffff"
images:
- http://example.com/index.png
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
execution result Returned: success Sample: |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication