Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gahlawat/laravel-slack
A minimalist laravel package to post messages or notifications to your team's Slack.
https://github.com/gahlawat/laravel-slack
laravel notifications slack
Last synced: about 1 month ago
JSON representation
A minimalist laravel package to post messages or notifications to your team's Slack.
- Host: GitHub
- URL: https://github.com/gahlawat/laravel-slack
- Owner: gahlawat
- License: mit
- Created: 2015-08-01T15:52:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-06-30T18:59:18.000Z (over 6 years ago)
- Last Synced: 2024-10-25T19:58:23.189Z (2 months ago)
- Topics: laravel, notifications, slack
- Language: PHP
- Homepage: https://gahlawat.github.io/laravel-slack
- Size: 32.2 KB
- Stars: 25
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# laravel-slack
[](https://twitter.com/JiveshGahlawat)
[](https://travis-ci.org/gahlawat/laravel-slack)
[](https://scrutinizer-ci.com/g/gahlawat/laravel-slack/?branch=master)
[](https://codeclimate.com/github/gahlawat/laravel-slack)
[](https://packagist.org/packages/jivesh/laravel-slack)
[](https://packagist.org/packages/jivesh/laravel-slack)
[](https://packagist.org/packages/jivesh/laravel-slack)
[](https://insight.sensiolabs.com/projects/9968ff31-0d2a-4aa2-9a36-5d8a63742311)
A very tiny and lightweight integration with the Slack API for posting notifications or any kind of messages to your team's Slack account.
---
- [Requirements](#requirements)
- [Installation](#installation)
- [Registering the Package](#registering-the-package)
- [Configuration](#configuration)
- [Usage](#usage)
## Requirements
* Laravel Framework 5+
## Installation
Using [Composer](https://getcomposer.org/) package manager, install this package by running following command in your project root:
```sh
$ composer require jivesh/laravel-slack
```
## Registering the Package
- This package supports auto discovery feature introduced in Laravel v5.5, hence it is auto registered. You may skip to 'Configuration' section below.
- If your app is on Laravel v5.4 or below, follow below steps to register:
- In your ```config/app.php``` file, append the following code into your ```providers``` array for integrating the Service Provider for package.
```php
/**
* Package Service Provider
*/
'providers' => [
// ...
Gahlawat\Slack\SlackServiceProvider::class,
],
```
- Again in your ```config/app.php``` file, copy the following code into your ```aliases``` array for a nice Laravel syntax using Facades.
```php
/**
* Package Alias
*/
'aliases' => [
// ...
'Slack' => Gahlawat\Slack\Facade\Slack::class,
],
```
## Configuration
- [Create an incoming webhook](https://www.slack.com/services/new/incoming-webhook) on your Slack account for the package to use and copy the generated Webhook URL.
- Run the following command in project root directory to generate config file for package.
```sh
$ php artisan vendor:publish
```
- Now edit ```config/slack.php``` and paste value for ```incoming-webhook``` generated in the first step above.
- You may optionally set a default username and emoji icon displayed in your Slack app from here.
## Usage
- Send any message in real time to your Slack account using this anywhere in your php code:
```php
\Slack::send("your-message");
```
- The backslash indicates global namespace scope for this function, you may import Slack namespace on top of your file by ```using``` it:
```php
use Slack;
```
- Then, you can call this Facade without a ```\``` as:
```php
Slack::send("your-message");
```
- You can change the default name and/or display icon in your Slack app for any message by using optional second and third parameter.
- To send this message privately to any user, use the fourth parameter as **@username**
- To send this message publicly to any channel, use the fourth parameter as **#channel**
```php
Slack::send("your-message" [,"display-name" [,"display-emoji"] [,"#channel" or "@username"]]);
// here [] indicates optional parameters
```
See this [cheat sheet](http://www.emoji-cheat-sheet.com) of available emoji icons.