Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomatophp/filament-discord
Send Notification to discord channel Webhook using native FilamentPHP Notification Facade class
https://github.com/tomatophp/filament-discord
discord filament-notifications filament-plugin integration
Last synced: 19 days ago
JSON representation
Send Notification to discord channel Webhook using native FilamentPHP Notification Facade class
- Host: GitHub
- URL: https://github.com/tomatophp/filament-discord
- Owner: tomatophp
- License: mit
- Created: 2024-07-09T13:43:53.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-09-11T14:50:06.000Z (3 months ago)
- Last Synced: 2024-11-16T17:51:28.212Z (about 1 month ago)
- Topics: discord, filament-notifications, filament-plugin, integration
- Language: PHP
- Homepage: https://tomatophp.com/en/open-source/filament-discord
- Size: 2.25 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Filament Discord Notifications
[](https://packagist.org/packages/tomatophp/filament-discord)
[](https://packagist.org/packages/tomatophp/filament-discord)
[](https://packagist.org/packages/tomatophp/filament-discord)
Send Notification to discord channel Webhook using native FilamentPHP Notification Facade class
## Screenshots
## Installation
```bash
composer require tomatophp/filament-discord
```
after install on your `.env` file set
```.dotenv
DISCORD_WEBHOOK=
DISCORD_ERROR_WEBHOOK=
DISCORD_ERROR_WEBHOOK_ACTIVE=
```
where `DISCORD_WEBHOOK` the main notification channel webhook and `DISCORD_ERROR_WEBHOOK` is the error logger channel webhook and `DISCORD_ERROR_WEBHOOK_ACTIVE` to be true or false to active and stop logger
## Using
you can send notification to discord with multi-way the first of it is using native FilamentPHP `Notification::class`
```php
use \Filament\Notifications\Notification;
Notification::make()
->title('Hi')
->body('Welcome On The Moon!')
->sendToDiscord()
```
you can attach image to the message like this
```php
use \Filament\Notifications\Notification;
Notification::make()
->title('Hi')
->body('Welcome On The Moon!')
->sendToDiscord(image: "https://raw.githubusercontent.com/tomatophp/filament-discord/master/arts/3x1io-tomato-discord.jpg")
```
## Send to Selected User
you can send a notification to selected user webhook by add a column on your user table with name `webhook` and then add this tait to User model
```php
use TomatoPHP\FilamentDiscord\Traits\InteractsWithDiscord;
class User {
use InteractsWithDiscord;
}
```
and now you can send notification to the user like this
```php
use \Filament\Notifications\Notification;
Notification::make()
->title('Hi')
->body('Welcome On The Moon!')
->sendToDiscord($user)
```
## Allow Discord Error Logger
you can use Discord channel as an error logger to log and followup your error with a very easy way, on your `bootstrap/app.php` add this class like this
```php
use Illuminate\Foundation\Application;
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Foundation\Configuration\Middleware;
use ProtoneMedia\Splade\Http\SpladeMiddleware;
return Application::configure(basePath: dirname(__DIR__))
->withRouting(
web: __DIR__.'/../routes/web.php',
api: __DIR__.'/../routes/api.php',
commands: __DIR__.'/../routes/console.php',
channels: __DIR__.'/../routes/channels.php',
health: '/up',
)
->withMiddleware(function (Middleware $middleware) {
})
->withExceptions(function (Exceptions $exceptions) {
\TomatoPHP\FilamentDiscord\Helpers\DiscordErrorReporter::make($exceptions);
})->create();
```
## Publish Assets
you can publish config file by use this command
```bash
php artisan vendor:publish --tag="filament-discord-config"
```
## Other Filament Packages
Checkout our [Awesome TomatoPHP](https://github.com/tomatophp/awesome)