Download the PHP package spatie/laravel-slack-alerts without Composer

On this page you can find all versions of the php package spatie/laravel-slack-alerts. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of spatie/laravel-slack-alerts

Informations about the package laravel-slack-alerts

Quickly send a message to Slack

Latest Version on Packagist run-tests Check & fix styling Total Downloads

This package can quickly send alerts to Slack. You can use this to notify yourself of any noteworthy events happening in your app.

Under the hood, a job is used to communicate with Slack. This prevents your app from failing in case Slack is down.

Want to send alerts to Discord instead? Check out laravel-discord-alerts.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

You can set a SLACK_ALERT_WEBHOOK env variable containing a valid Slack webhook URL. You can learn how to get a webhook URL in the Slack API docs.

Alternatively, you can publish the config file with:

This is the contents of the published config file:

Usage

To send a message to Slack, simply call SlackAlert::message() and pass it any message you want.

Sending blocks

Slack supports sending rich formatting using their Block Kit API, you can send a set of blocks using the blocks() method:

Using multiple webhooks

You can also use an alternative webhook, by specify extra ones in the config file.

The webhook to be used can be chosen using the to function.

Using a custom webhooks

The to function also supports custom webhook urls.

Sending message to an alternative channel

You can send a message to a channel other than the default one for the webhook, by passing it to the toChannel function.

Queuing

By default, messages are sent by dispatching the job to the default queue.

Configuring the queue

In .env file, add

Changing the queue at runtime

You can queue the job to a different queue than the one defined in config by passing it to the onQueue function.

Formatting

Markdown

You can format your messages with Slack's markup. Learn how in the Slack API docs.

Links are formatted differently in Slack than the classic markdown structure.

Emoji's

You can use the same emoji codes as in Slack. This means custom emoji's are also supported.

Mentioning

You can use mentions to notify users and groups. Learn how in the Slack API docs.

Icon Change

You can change the icon that appears next to the display-name at the top of the message.

Display Name Change

You can change the Display-Name that appears next to the display-name at the top of the message.

Usage in tests

In your tests, you can make use of the SlackAlert facade to assert whether your code sent an alert to Slack.

Of course, you can also assert that a message wasn't sent to Slack.

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

Alternatives

If you want to do more complex stuff with Block Kit, we suggest using slack-php/slack-php-block-kit

All versions of laravel-slack-alerts with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
spatie/laravel-package-tools Version ^1.9.2
illuminate/contracts Version ^8.73|^9.0|^10.0|^11.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package spatie/laravel-slack-alerts contains the following files

Loading the files please wait ....