Manage webhooks from the panel
Create one and see its secret once, send a test, change the secret, and read each delivery with what the other end answered. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
229
app/Filament/Resources/Webhooks/WebhookResource.php
Normal file
229
app/Filament/Resources/Webhooks/WebhookResource.php
Normal file
@@ -0,0 +1,229 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace App\Filament\Resources\Webhooks;
|
||||
|
||||
use App\Filament\Resources\Webhooks\Pages\CreateWebhook;
|
||||
use App\Filament\Resources\Webhooks\Pages\EditWebhook;
|
||||
use App\Filament\Resources\Webhooks\Pages\ListWebhooks;
|
||||
use App\Filament\Resources\Webhooks\RelationManagers\DeliveriesRelationManager;
|
||||
use App\Models\Webhook;
|
||||
use App\Rules\PublicHttpsUrl;
|
||||
use App\Support\Webhooks\Webhooks;
|
||||
use BackedEnum;
|
||||
use Filament\Actions\Action;
|
||||
use Filament\Actions\DeleteAction;
|
||||
use Filament\Actions\EditAction;
|
||||
use Filament\Forms\Components\CheckboxList;
|
||||
use Filament\Forms\Components\TextInput;
|
||||
use Filament\Forms\Components\Toggle;
|
||||
use Filament\Notifications\Notification;
|
||||
use Filament\Resources\Resource;
|
||||
use Filament\Schemas\Components\Section;
|
||||
use Filament\Schemas\Schema;
|
||||
use Filament\Support\Icons\Heroicon;
|
||||
use Filament\Tables\Columns\IconColumn;
|
||||
use Filament\Tables\Columns\TextColumn;
|
||||
use Filament\Tables\Table;
|
||||
use Illuminate\Support\Str;
|
||||
use UnitEnum;
|
||||
|
||||
/**
|
||||
* Outgoing webhooks: where to tell when something happens here, and how each
|
||||
* delivery went.
|
||||
*/
|
||||
class WebhookResource extends Resource
|
||||
{
|
||||
protected static ?string $model = Webhook::class;
|
||||
|
||||
protected static string|BackedEnum|null $navigationIcon = Heroicon::OutlinedBolt;
|
||||
|
||||
protected static ?int $navigationSort = 85;
|
||||
|
||||
protected static ?string $recordTitleAttribute = 'name';
|
||||
|
||||
public static function getModelLabel(): string
|
||||
{
|
||||
return __('panel.webhooks.label');
|
||||
}
|
||||
|
||||
public static function getPluralModelLabel(): string
|
||||
{
|
||||
return __('panel.webhooks.plural');
|
||||
}
|
||||
|
||||
public static function getNavigationGroup(): string|UnitEnum|null
|
||||
{
|
||||
return __('panel.groups.administration');
|
||||
}
|
||||
|
||||
/**
|
||||
* Red while one is switched off by failures: something is not hearing
|
||||
* what it signed up for.
|
||||
*/
|
||||
public static function getNavigationBadge(): ?string
|
||||
{
|
||||
$off = static::getModel()::query()
|
||||
->where('is_active', false)
|
||||
->where('consecutive_failures', '>=', Webhook::MAX_FAILURES)
|
||||
->count();
|
||||
|
||||
return $off > 0 ? (string) $off : null;
|
||||
}
|
||||
|
||||
public static function getNavigationBadgeColor(): ?string
|
||||
{
|
||||
return 'danger';
|
||||
}
|
||||
|
||||
public static function form(Schema $schema): Schema
|
||||
{
|
||||
return $schema->components([
|
||||
Section::make()
|
||||
->columns(2)
|
||||
->schema([
|
||||
TextInput::make('name')
|
||||
->label(__('panel.webhooks.fields.name'))
|
||||
->required()
|
||||
->maxLength(120),
|
||||
|
||||
TextInput::make('url')
|
||||
->label(__('panel.webhooks.fields.url'))
|
||||
->helperText(__('panel.webhooks.fields.url_hint'))
|
||||
->required()
|
||||
->url()
|
||||
->maxLength(2048)
|
||||
->rule(new PublicHttpsUrl),
|
||||
|
||||
CheckboxList::make('events')
|
||||
->label(__('panel.webhooks.fields.events'))
|
||||
->options(fn () => collect(['*', ...Webhook::EVENTS])
|
||||
->mapWithKeys(fn (string $event) => [$event => self::eventLabel($event)])
|
||||
->all())
|
||||
->descriptions(fn () => collect(['*', ...Webhook::EVENTS])
|
||||
->mapWithKeys(fn (string $event) => [$event => $event])
|
||||
->all())
|
||||
->required()
|
||||
->columns(2)
|
||||
->columnSpanFull(),
|
||||
|
||||
Toggle::make('include_personal_data')
|
||||
->label(__('panel.webhooks.fields.include_personal_data'))
|
||||
->helperText(__('panel.webhooks.fields.include_personal_data_hint')),
|
||||
|
||||
Toggle::make('is_active')
|
||||
->label(__('panel.webhooks.fields.is_active'))
|
||||
->default(true),
|
||||
]),
|
||||
]);
|
||||
}
|
||||
|
||||
public static function table(Table $table): Table
|
||||
{
|
||||
return $table
|
||||
->columns([
|
||||
TextColumn::make('name')
|
||||
->label(__('panel.webhooks.fields.name'))
|
||||
->weight('bold')
|
||||
->description(fn (Webhook $record) => $record->url)
|
||||
->searchable(),
|
||||
|
||||
TextColumn::make('events')
|
||||
->label(__('panel.webhooks.fields.events'))
|
||||
->badge()
|
||||
->color('gray'),
|
||||
|
||||
IconColumn::make('is_active')
|
||||
->label(__('panel.webhooks.fields.is_active'))
|
||||
->boolean(),
|
||||
|
||||
TextColumn::make('consecutive_failures')
|
||||
->label(__('panel.webhooks.fields.failures'))
|
||||
->color(fn (int $state) => $state > 0 ? 'danger' : 'gray'),
|
||||
|
||||
TextColumn::make('last_delivered_at')
|
||||
->label(__('panel.webhooks.fields.last_delivered_at'))
|
||||
->since()
|
||||
->dateTimeTooltip()
|
||||
->placeholder('—'),
|
||||
])
|
||||
->recordActions([
|
||||
self::pingAction(),
|
||||
EditAction::make(),
|
||||
DeleteAction::make(),
|
||||
]);
|
||||
}
|
||||
|
||||
public static function eventLabel(string $event): string
|
||||
{
|
||||
$key = str_replace('.', '_', $event);
|
||||
|
||||
return __("panel.webhooks.events.{$key}");
|
||||
}
|
||||
|
||||
public static function pingAction(): Action
|
||||
{
|
||||
return Action::make('ping')
|
||||
->label(__('panel.webhooks.actions.ping'))
|
||||
->icon('heroicon-o-paper-airplane')
|
||||
->color('gray')
|
||||
->authorize('update')
|
||||
->action(function (Webhook $record): void {
|
||||
Webhooks::ping($record);
|
||||
|
||||
Notification::make()
|
||||
->title(__('panel.webhooks.actions.ping_sent'))
|
||||
->body(__('panel.webhooks.actions.ping_hint'))
|
||||
->success()
|
||||
->send();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* A new secret, shown once. The old one stops being valid at once, so the
|
||||
* receiving end has to be updated straight after.
|
||||
*/
|
||||
public static function rotateAction(): Action
|
||||
{
|
||||
return Action::make('rotate_secret')
|
||||
->label(__('panel.webhooks.actions.rotate'))
|
||||
->icon('heroicon-o-key')
|
||||
->color('warning')
|
||||
->requiresConfirmation()
|
||||
->modalDescription(__('panel.webhooks.actions.rotate_hint'))
|
||||
->authorize('update')
|
||||
->action(function (Webhook $record): void {
|
||||
$secret = Str::random(40);
|
||||
$record->forceFill(['secret' => $secret])->save();
|
||||
|
||||
self::showSecret($secret);
|
||||
});
|
||||
}
|
||||
|
||||
public static function showSecret(string $secret): void
|
||||
{
|
||||
Notification::make()
|
||||
->title(__('panel.webhooks.secret.title'))
|
||||
->body(__('panel.webhooks.secret.body', ['secret' => $secret]))
|
||||
->warning()
|
||||
->persistent()
|
||||
->send();
|
||||
}
|
||||
|
||||
public static function getRelations(): array
|
||||
{
|
||||
return [
|
||||
DeliveriesRelationManager::class,
|
||||
];
|
||||
}
|
||||
|
||||
public static function getPages(): array
|
||||
{
|
||||
return [
|
||||
'index' => ListWebhooks::route('/'),
|
||||
'create' => CreateWebhook::route('/create'),
|
||||
'edit' => EditWebhook::route('/{record}/edit'),
|
||||
];
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user