README

Send spatie/laravel-health check failure notifications to a Discord channel via webhooks. Each failed check is formatted as a color-coded embed (green for OK, yellow for warning, red for failed/crashed).

Requirements

This package requires spatie/laravel-health to be installed and configured in your application. If you haven't set it up yet, follow their installation instructions first.

Installation

Install the package via Composer:

composer require donkooijman/discord-for-laravel-health

Configuration

You'll need a Discord webhook URL. You can learn how to create one in the Discord API docs.

Add your Discord webhook URL to your .env file:

HEALTH_DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/your/webhook-url

Optionally, publish the config file:

php artisan vendor:publish --tag="discord-for-laravel-health-config"

Then configure spatie/laravel-health to use the package's notifiable and notification classes in config/health.php:

'notifications' => [
    // ...

    'notifiable' => \DonKooijman\DiscordForLaravelHealth\Notifications\HealthNotifiable::class,

    'notifications' => [
        \DonKooijman\DiscordForLaravelHealth\Notifications\HealthCheckFailedNotification::class => ['discord'],
    ],
],

Testing

composer test

Changelog

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

License

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

donkooijman / discord-for-laravel-health

Maintainers

Details