community.general.slack module – Send Slack notifications
Note
This module is part of the community.general collection (version 10.1.0).
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.slack.
Synopsis
The community.general.slack module sends notifications to http://slack.com via the Incoming WebHook integration
Parameters
Parameter |
Comments |
|---|---|
Define a list of attachments. This list mirrors the Slack JSON API. For more information, see https://api.slack.com/docs/attachments. |
|
Define a list of blocks. This list mirrors the Slack JSON API. For more information, see https://api.slack.com/block-kit. |
|
Channel to send the message to. If absent, the message goes to the channel selected for the |
|
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. Default: |
|
Slack (sub)domain for your environment without protocol. (For example |
|
Emoji for the message sender. See Slack documentation for options. If |
|
URL for the message sender’s icon. Default: |
|
Optional. Message ID to edit, instead of posting a new message. If supplied The token needs history scope to get information on the message to edit ( Corresponds to |
|
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 (https://api.slack.com/docs/message-formatting) for more. |
|
Setting for the message parser at Slack Choices:
|
|
Setting for automatically prepending a The Choices:
|
|
Optional. Timestamp of parent message to thread this message. https://api.slack.com/docs/message-threading |
|
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 Ansible 1.8, a token looked like WebAPI token: Slack WebAPI requires a personal, bot or work application token. These tokens start with |
|
This is the sender of the message. Default: |
|
If Choices:
|
Attributes
Attribute |
Support |
Description |
|---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Send notification message via Slack
community.general.slack:
token: thetoken/generatedby/slack
msg: '{{ inventory_hostname }} completed'
delegate_to: localhost
- name: Send notification message via Slack all options
community.general.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
community.general.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
community.general.slack:
token: thetoken/generatedby/slack
msg: 'This message uses color in hex value'
color: '#00aacc'
username: ''
icon_url: ''
- name: Use the attachments API
community.general.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: Use the blocks API
community.general.slack:
token: thetoken/generatedby/slack
blocks:
- type: section
text:
type: mrkdwn
text: |-
*System load*
Display my system load on host A and B
- type: context
elements:
- type: mrkdwn
text: |-
*System A*
load average: 0,74, 0,66, 0,63
- type: mrkdwn
text: |-
*System B*
load average: 5,16, 4,64, 2,43
- name: Send a message with a link using Slack markup
community.general.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
community.general.slack:
token: thetoken/generatedby/slack
msg: This message has <brackets> & ampersands in plain text.
- name: Initial Threaded Slack message
community.general.slack:
channel: '#ansible'
token: xoxb-1234-56789abcdefghijklmnop
msg: 'Starting a thread with my initial post.'
register: slack_response
- name: Add more info to thread
community.general.slack:
channel: '#ansible'
token: xoxb-1234-56789abcdefghijklmnop
thread_id: "{{ slack_response['ts'] }}"
color: good
msg: 'And this is my threaded response!'
- name: Send a message to be edited later on
community.general.slack:
token: thetoken/generatedby/slack
channel: '#ansible'
msg: Deploying something...
register: slack_response
- name: Edit message
community.general.slack:
token: thetoken/generatedby/slack
# The 'channel' option does not accept the channel name. It must use the 'channel_id',
# which can be retrieved for example from 'slack_response' from the previous task.
channel: "{{ slack_response.channel }}"
msg: Deployment complete!
message_id: "{{ slack_response.ts }}"