https://github.com/tappnetwork/filament-webhook-client
https://github.com/tappnetwork/filament-webhook-client
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tappnetwork/filament-webhook-client
- Owner: TappNetwork
- License: mit
- Created: 2024-05-22T21:36:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T21:28:41.000Z (over 1 year ago)
- Last Synced: 2024-12-04T21:42:33.011Z (over 1 year ago)
- Language: PHP
- Size: 1010 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Filament Webhook Client Plugin
[](https://packagist.org/packages/tapp/filament-webhook-client)
[](https://packagist.org/packages/tapp/filament-webhook-client)
This plugin adds a Filament resource and a policy for [Spatie Webhook Client](https://github.com/spatie/laravel-webhook-client/).
## Installation
> [!IMPORTANT]
> First, make sure you have [Spatie Webhook Client](https://github.com/spatie/laravel-webhook-client/)
> installed and configured.
You can install the package via composer:
```bash
composer require tapp/filament-webhook-client
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="filament-webhook-client-config"
```
This is the contents of the published config file:
```php
return [
'resources' => [
'WebhookCallResource' => \Tapp\FilamentWebhookClient\Resources\WebhookCallResource::class,
],
'models' => [
'webhook-call' => \Spatie\WebhookClient\Models\WebhookCall::class,
],
'policies' => [
'webhook-call' => \Tapp\FilamentWebhookClient\Policies\WebhookCallPolicy::class,
],
'navigation' => [
'sort' => 1,
'icon' => 'heroicon-o-rectangle-stack',
],
];
```
Optionally, you can publish the translations file using:
```bash
php artisan vendor:publish --tag="filament-webhook-client-translations"
```
## Usage
Add this plugin to a panel on `plugins()` method.
E.g. in `app/Providers/Filament/AdminPanelProvider.php`:
```php
use Tapp\FilamentWebhookClient\FilamentWebhookClientPlugin;
public function panel(Panel $panel): Panel
{
return $panel
// ...
->plugins([
FilamentWebhookClientPlugin::make(),
//...
]);
}
```
#### Appareance
Webhook calls resource content example:
Webhook calls view content example:
## Webhook Call Policy
By default, the policy included in this plugin allows you to view the list of webhook calls and an individual webhook call.
If you need to change the permissions, you can override the policy by creating a policy in you project and adding it on `policies -> webhook-call` entry on `filament-webhook-client.php` config file.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
If you discover any security-related issues, please email security@tappnetwork.com.
## Credits
- [Tapp Network](https://github.com/TappNetwork)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.