tapp/filament-webhook-client

Add a Filament resource and a policy for Spatie Webhook client

v1.0.0 2024-06-04 16:56 UTC

This package is auto-updated.

Last update: 2024-09-08 20:24:35 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This plugin adds a Filament resource and a policy for Spatie Webhook Client.

Installation

Important

First, make sure you have Spatie Webhook Client installed and configured.

You can install the package via composer:

composer require tapp/filament-webhook-client

You can publish the config file with:

php artisan vendor:publish --tag="filament-webhook-client-config"

This is the contents of the published config file:

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:

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:

use Tapp\FilamentWebhookClient\FilamentWebhookClientPlugin;
 
public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->plugins([
            FilamentWebhookClientPlugin::make(),
            //...
        ]);
}

Appareance

Webhook calls resource content example:

Filament Webhook Calls resource list

Webhook calls view content example:

Filament Webhook Calls view record

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

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

If you discover any security-related issues, please email security@tappnetwork.com.

Credits

License

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