salt.modules.slack_notify¶
Module for sending messages to Slack
New in version 2015.5.0.
| configuration: | This module can be used by either passing an api key and version directly or by specifying both in a configuration profile in the salt master/minion config. For example: slack:
api_key: peWcBiMOS9HrZG15peWcBiMOS9HrZG15
|
|---|
-
salt.modules.slack_notify.find_room(name, api_key=None)¶ Find a room by name and return it. :param name: The room name. :param api_key: The Slack admin api key. :return: The room object.
CLI Example:
salt '*' slack.find_room name="random" salt '*' slack.find_room name="random" api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
-
salt.modules.slack_notify.find_user(name, api_key=None)¶ Find a user by name and return it. :param name: The user name. :param api_key: The Slack admin api key. :return: The user object.
CLI Example:
salt '*' slack.find_user name="ThomasHatch" salt '*' slack.find_user name="ThomasHatch" api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
-
salt.modules.slack_notify.list_rooms(api_key=None)¶ List all Slack rooms.
Parameters: api_key -- The Slack admin api key. Returns: The room list. CLI Example:
salt '*' slack.list_rooms salt '*' slack.list_rooms api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
-
salt.modules.slack_notify.list_users(api_key=None)¶ List all Slack users. :param api_key: The Slack admin api key. :return: The user list.
CLI Example:
salt '*' slack.list_users salt '*' slack.list_users api_key=peWcBiMOS9HrZG15peWcBiMOS9HrZG15
-
salt.modules.slack_notify.post_message(channel, message, from_name, api_key=None)¶ Send a message to a Slack channel. :param channel: The channel name, either will work. :param message: The message to send to the HipChat room. :param from_name: Specify who the message is from. :param api_key: The Slack api key, if not specified in the configuration. :return: Boolean if message was sent successfully.
CLI Example:
salt '*' slack.send_message channel="Development Room" message="Build is done" from_name="Build Server"
