mountain/laraslack

A simple package to automatically send alerts to a slack channel

v0.1.0 2021-10-15 14:34 UTC

Requires

• php: >=7.0
• ext-curl: *

MIT

• ThomasMountain

• laravel
• slack

README

About

A Basic Slack integration for Laravel projects

Usage

Register a helper function instantiating the LaraSlack class e.g.

function laraslack($content) {
	return new \ThomasMountain\LaraSlack\LaraSlack($content);
}

Required ENV

• SLACK_WEB_HOOK_URL=
  • String
  • The Slack web hook url
• SLACK_CHANNEL=
  • String
  • The channel or user to send the message to
• SLACK_USERNAME=
  • String
  • The username to send the message as
• SLACK_ICON=
  • String
  • The icon to be sent with the message (wrapped in ':' i.e 📈)
• SLACK_SEND=
  • Boolean
  • Determines wether the message will be sent
  • Set to false in testing environments

Overriding Defaults

You can pass an array to the send() method to overwride the defaults specified in the .env file. The array keys are:

• channel
• message
• username
• icon

Any array keys that are not passed through will take the defaults from the config

E.G:

laraslack([
    'channel' => 'Dummy Channel',
    'icon'    => ':bananadance:',
    'message  => 'message goes here'
]);

** Remember to pass through an array key for 'message' when doing this **