Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MarJose123/filament-webhook-server
Send webhooks from Filament apps
https://github.com/MarJose123/filament-webhook-server
Last synced: about 1 month ago
JSON representation
Send webhooks from Filament apps
- Host: GitHub
- URL: https://github.com/MarJose123/filament-webhook-server
- Owner: MarJose123
- License: mit
- Created: 2023-01-16T02:35:05.000Z (almost 2 years ago)
- Default Branch: 2.x
- Last Pushed: 2024-09-22T02:18:26.000Z (3 months ago)
- Last Synced: 2024-10-24T18:05:22.276Z (about 2 months ago)
- Language: PHP
- Homepage:
- Size: 273 KB
- Stars: 36
- Watchers: 1
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- awesome-filament - MarJose123/filament-webhook-server - Send webhooks from Filament apps. (Complete Sections)
README
# Send webhooks from your filament apps
[](https://packagist.org/packages/marjose123/filament-webhook-server)
[](https://packagist.org/packages/marjose123/filament-webhook-server)
This package provides a Filament page that you can send webhook server . You'll find installation instructions and full documentation on [spatie/laravel-webhook-server](https://github.com/spatie/laravel-webhook-server).
---
:rotating_light: _For latest version that support FilamentPhp v2.x use this branch [1.x](https://github.com/MarJose123/filament-webhook-server/tree/1.x)_or released version "^1.0"
## Installation
You can install the package via composer:
```bash
composer require marjose123/filament-webhook-server:"^2.0"
```
You can publish and run the migrations with:
```bash
php artisan vendor:publish --tag="filament-webhook-server-migrations"
php artisan migrate
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="filament-webhook-server-config"
```
This is the contents of the published config file:
```php
return [
/*
* Models that you want to be part of the webhooks options
*/
'models' => [
\App\Models\User::class,
],
/*
*/
'polling' => '10s'
];
```
Add the plugin to your panel and you're ready to go
```php
use Marjose123\FilamentWebhookServer\WebhookPlugin;
public function panel(Panel $panel): Panel
{
return $panel
// ...
->plugins([
WebhookPlugin::make() // <- Add this
]);
}
```
## Usage
> 1. Add the models that you want to be part of the webhook
> 2. This package will automatically register the `Webhook-Server`. You'll be able to see it when you visit your Filament admin panel.
## Customising the polling interval
You can customise the polling interval for the `Webhook-Server` by publishing the configuration file and updating the `polling` value.
## Webhook payload Structure
```
[
{
"event": "created", // <== Type of Event
"module": "Testing", // <== Module that were the event happend
"triggered_at": "2023-01-18T05:07:37.748031Z", // <== Based on the Date and time the Event happen
"data": { // <== Actual information depending on what you selected "Summary, All or Custom"
"id": 34,
"created_at": "2023-01-18T05:07:37.000000Z"
}
}
]
```
for custom option you need to create toWebhookPayload method in your models
```
public function toWebhookPayload()
{
return [
'customAttribute' => $this->yourAttribute
];
}
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Marjose](https://github.com/MarJose123)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.