Try SpotterSend Slack notifications
Authors: Ramon de la Fuente (@ramondelafuente)
Install with ansible-galaxy collection install community.general:==0.2.1
collections:
- name: community.general
version: 0.2.1The C(slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration
- name: Send notification message via Slack
slack:
token: thetoken/generatedby/slack
msg: '{{ inventory_hostname }} completed'
delegate_to: localhost
- name: Send notification message via Slack all options
slack:
token: thetoken/generatedby/slack
msg: '{{ inventory_hostname }} completed'
channel: '#ansible'
thread_id: '1539917263.000100'
username: 'Ansible on {{ inventory_hostname }}'
icon_url: http://www.example.com/some-image-file.png
link_names: 0
parse: 'none'
delegate_to: localhost
- name: Insert a color bar in front of the message for visibility purposes and use the default webhook icon and name configured in Slack
slack:
token: thetoken/generatedby/slack
msg: '{{ inventory_hostname }} is alive!'
color: good
username: ''
icon_url: ''
- name: Insert a color bar in front of the message with valid hex color value
slack:
token: thetoken/generatedby/slack
msg: 'This message uses color in hex value'
color: '#00aacc'
username: ''
icon_url: ''
- name: Use the attachments API
slack:
token: thetoken/generatedby/slack
attachments:
- text: Display my system load on host A and B
color: '#ff00dd'
title: System load
fields:
- title: System A
value: "load average: 0,74, 0,66, 0,63"
short: True
- title: System B
value: 'load average: 5,16, 4,64, 2,43'
short: True
- name: Send a message with a link using Slack markup
slack:
token: thetoken/generatedby/slack
msg: We sent this message using <https://www.ansible.com|Ansible>!
- name: Send a message with angle brackets and ampersands
slack:
token: thetoken/generatedby/slack
msg: This message has <brackets> & ampersands in plain text.
- name: Initial Threaded Slack message
slack:
channel: '#ansible'
token: xoxb-1234-56789abcdefghijklmnop
msg: 'Starting a thread with my initial post.'
register: slack_response
- name: Add more info to thread
slack:
channel: '#ansible'
token: xoxb-1234-56789abcdefghijklmnop
thread_id: "{{ slack_response['ts'] }}"
color: good
msg: 'And this is my threaded response!'
msg:
description:
- Message to send. Note that the module does not handle escaping characters. Plain-text
angle brackets and ampersands should be converted to HTML entities (e.g. & to &)
before sending. See Slack's documentation (U(https://api.slack.com/docs/message-formatting))
for more.
color:
default: normal
description:
- Allow text to use default colors - use the default of 'normal' to not send a custom
color bar at the start of the message.
- Allowed values for color can be one of 'normal', 'good', 'warning', 'danger', any
valid 3 digit or 6 digit hex color value.
- Specifying value in hex is supported since Ansible 2.8.
parse:
choices:
- full
- none
description:
- Setting for the message parser at Slack
token:
description:
- Slack integration token. This authenticates you to the slack service. Make sure
to use the correct type of token, depending on what method you use.
- 'Webhook token: Prior to 1.8, a token looked like C(3Ffe373sfhRE6y42Fg3rvf4GlK). In
1.8 and above, ansible adapts to the new slack API where tokens look like C(G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK). If
tokens are in the new format then slack will ignore any value of domain. If the
token is in the old format the domain is required. Ansible has no control of when
slack will get rid of the old API. When slack does that the old format will stop
working. ** Please keep in mind the tokens are not the API tokens but are the webhook
tokens. In slack these are found in the webhook URL which are obtained under the
apps and integrations. The incoming webhooks can be added in that area. In some
cases this may be locked by your Slack admin and you must request access. It is
there that the incoming webhooks can be added. The key is on the end of the URL
given to you in that section.'
- 'WebAPI token: Slack WebAPI requires a personal, bot or work application token.
These tokens start with C(xoxp-), C(xoxb-) or C(xoxa-), eg. C(xoxb-1234-56789abcdefghijklmnop).
WebAPI token is required if you inted to receive and use thread_id. See Slack''s
documentation (U(https://api.slack.com/docs/token-types)) for more information.'
required: true
domain:
description:
- Slack (sub)domain for your environment without protocol. (i.e. C(example.slack.com))
In 1.8 and beyond, this is deprecated and may be ignored. See token documentation
for information.
channel:
description:
- Channel to send the message to. If absent, the message goes to the channel selected
for the I(token).
icon_url:
description:
- Url for the message sender's icon (default C(https://www.ansible.com/favicon.ico))
username:
default: Ansible
description:
- This is the sender of the message.
thread_id:
description:
- Optional. Timestamp of parent message to thread this message. https://api.slack.com/docs/message-threading
type: str
icon_emoji:
description:
- Emoji for the message sender. See Slack documentation for options. (if I(icon_emoji)
is set, I(icon_url) will not be used)
link_names:
choices:
- 1
- 0
default: 1
description:
- Automatically create links for channels and usernames in I(msg).
attachments:
description:
- Define a list of attachments. This list mirrors the Slack JSON API.
- For more information, see also in the (U(https://api.slack.com/docs/attachments)).
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