Awesome
ravenx_slack
Ravenx strategy to send Slack notifications
Installation
The package can be installed as simply as adding ravenx
and ravenx_slack
to your list of dependencies in mix.exs
:
def deps do
[
{:ravenx, "~> 2.0"},
{:ravenx_slack, "~> 0.1"}
]
end
Configuration
To enable this strategy, just specify it in your ravenx
configuration:
config :ravenx,
strategies: [
slack: Ravenx.Strategy.Slack
]
Available configuration
The module can be configured as mentioned on the Ravenx's README, been able to configure the following variables:
- url: the URL of the webhook you have isntalled in your Slack.
- channel: channel to post the message. If not specified, will use default's one specified in the webhook configuration.
- username: User name to show in the notification. If not specified, will use default's one specified in the webhook configuration.
- icon_emoji: Emoji to use in the notification as avatar. If not specified, will use default's one specified in the webhook configuration.
Payload
Any field specified
in the official documentation can be
send in a map
as the payload.
Contribute
All contributions are welcome, and we really hope this repo will serve for beginners as well for more advanced developers.
If you have any doubt, feel free to ask, but always respecting our Code of Conduct.
To contribute, create a fork of the repository, make your changes and create a PR. And remember, talking on PRs/issues is a must!