mattermost – Send Mattermost notifications¶
Synopsis¶
- Sends notifications to http://your.mattermost.url via the Incoming WebHook integration.
Parameters¶
Examples¶
- name: Send notification message via Mattermost
  mattermost:
    url: http://mattermost.example.com
    api_key: my_api_key
    text: '{{ inventory_hostname }} completed'
- name: Send notification message via Mattermost all options
  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 | 
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Benjamin Jolivot (@bjolivot)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
