community.general.mattermost – Send Mattermost notifications

Note

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

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.mattermost.

Synopsis

Parameters

Parameter Choices/Defaults Comments
api_key
string / required
Mattermost webhook api key. Log into your mattermost site, go to Menu -> Integration -> Incoming Webhook -> Add Incoming Webhook. This will give you full URL. api_key is the last part. http://mattermost.example.com/hooks/API_KEY
channel
string
Channel to send the message to. If absent, the message goes to the channel selected for the api_key.
icon_url
string
Default:
"https://www.ansible.com/favicon.ico"
Url for the message sender's icon.
text
string / required
Text to send. Note that the module does not handle escaping characters.
url
string / required
Mattermost url (i.e. http://mattermost.yourcompany.com).
username
string
Default:
"Ansible"
This is the sender of the message (Username Override need to be enabled by mattermost admin, see mattermost doc.
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 notification message via Mattermost
  community.general.mattermost:
    url: http://mattermost.example.com
    api_key: my_api_key
    text: '{{ inventory_hostname }} completed'

- name: Send notification message via Mattermost all options
  community.general.mattermost:
    url: http://mattermost.example.com
    api_key: my_api_key
    text: '{{ inventory_hostname }} completed'
    channel: notifications
    username: 'Ansible on {{ inventory_hostname }}'
    icon_url: http://www.example.com/some-image-file.png

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
payload
string
success
Mattermost payload
webhook_url
string
success
URL the webhook is sent to


Authors

  • Benjamin Jolivot (@bjolivot)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/mattermost_module.html