feat: Webhooks

composer.json

@@ -33,6 +33,7 @@
         "spatie/laravel-data": "^4.11",
         "spatie/laravel-query-builder": "^5.5",
         "spatie/laravel-settings": "^3.2",
+        "spatie/laravel-webhook-server": "^3.8",
         "timacdonald/json-api": "^1.0.0-beta.4",
         "twig/twig": "^3.0"
     },

config/cachet.php

@@ -107,4 +107,21 @@
      |
      */
     'docker' => env('CACHET_DOCKER', false),
+
+    /*
+     |--------------------------------------------------------------------------
+     | Cachet Webhooks
+     |--------------------------------------------------------------------------
+     |
+     | Configure how Cachet sends webhooks for events.
+     |
+     */
+    'webhooks' => [
+        'queue_connection' => env('CACHET_WEBHOOK_QUEUE_CONNECTION', 'default'),
+        'queue_name' => env('CACHET_WEBHOOK_QUEUE_NAME', 'webhooks'),
+
+        'logs' => [
+            'prune_logs_after_days' => 30,
+        ],
+    ],
 ];

database/factories/WebhookAttemptFactory.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Cachet\Database\Factories;
+
+use Cachet\Enums\WebhookEventEnum;
+use Cachet\Models\WebhookAttempt;
+use Cachet\Models\WebhookSubscription;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\Cachet\Models\WebhookAttempt>
+ */
+class WebhookAttemptFactory extends Factory
+{
+    protected $model = WebhookAttempt::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'subscription_id' => WebhookSubscription::factory(),
+            'event' => WebhookEventEnum::component_created,
+            'attempt' => 0,
+            'payload' => [],
+            'response_code' => 200,
+            'transfer_time' => 0.1,
+        ];
+    }
+}

database/factories/WebhookSubscriptionFactory.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Cachet\Database\Factories;
+
+use Cachet\Models\WebhookSubscription;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\Cachet\Models\WebhookSubscription>
+ */
+class WebhookSubscriptionFactory extends Factory
+{
+    protected $model = WebhookSubscription::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'url' => fake()->url,
+            'secret' => fake()->randomAscii(),
+            'description' => fake()->sentence(),
+            'send_all_events' => false,
+            'selected_events' => [],
+        ];
+    }
+
+    /**
+     * Create a webhook subscription that is enabled for all events
+     */
+    public function allEvents(): self
+    {
+        return $this->state([
+            'send_all_events' => true,
+        ]);
+    }
+
+    /**
+     * Create a webhook subscription that is only enabled
+     * for the given events.
+     */
+    public function selectedEvents(array $events): self
+    {
+        return $this->state([
+            'selected_events' => $events,
+        ]);
+    }
+}

database/migrations/2025_01_02_193833_create_webhook_subscriptions_table.php

@@ -0,0 +1,34 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('webhook_subscriptions', function (Blueprint $table) {
+            $table->id();
+            $table->string('url');
+            $table->string('secret');
+            $table->string('description')->nullable();
+            $table->boolean('send_all_events')->default(true);
+            $table->json('selected_events')->nullable();
+            $table->decimal('success_rate_24h', 5, 2)->nullable();
+
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('webhook_subscriptions');
+    }
+};

database/migrations/2025_01_03_144743_create_webhook_attempts_table.php

@@ -0,0 +1,34 @@
+<?php
+
+use Cachet\Models\WebhookSubscription;
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('webhook_attempts', function (Blueprint $table) {
+            $table->id();
+            $table->foreignIdFor(WebhookSubscription::class, 'subscription_id')->onDelete('cascade');
+            $table->string('event');
+            $table->unsignedTinyInteger('attempt');
+            $table->json('payload');
+            $table->unsignedSmallInteger('response_code')->nullable();
+            $table->unsignedTinyInteger('transfer_time')->nullable();
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::drop('webhook_attempts');
+    }
+};

resources/lang/en/navigation.php

@@ -7,6 +7,7 @@
             'manage_cachet' => 'Manage Cachet',
             'manage_customization' => 'Manage Customization',
             'manage_theme' => 'Manage Theme',
+            'manage_webhooks' => 'Manage Webhooks',
         ],
     ],
 

resources/lang/en/webhook.php

@@ -0,0 +1,30 @@
+<?php
+
+return [
+    'resource_label' => 'Webhook|Webhooks',
+    'event_selection' => [
+        'all' => 'Send all events',
+        'selected' => 'Only send selected events',
+    ],
+    'form' => [
+        'url_label' => 'Payload URL',
+        'url_helper' => 'Events will POST to this URL.',
+        'secret_label' => 'Secret',
+        'secret_helper' => 'The payload will be signed with this secret. See *webhook documentation* for more information.',
+        'description_label' => 'Description',
+        'event_selection_label' => 'Send all events?',
+        'events_label' => 'Events',
+        'edit_secret_label' => 'Edit secret',
+        'update_secret_label' => 'Update secret',
+    ],
+    'attempts' => [
+        'heading' => 'Attempts',
+        'empty_state' => 'No attempts have been made to this webhook yet',
+    ],
+    'list' => [
+        'headers' => [
+            'url' => 'Payload URL',
+            'success_rate_24h' => 'Success rate (24h)',
+        ],
+    ],
+];

resources/views/filament/pages/settings/edit-webhook-subscription.blade.php

@@ -0,0 +1,14 @@
+<x-filament-panels::page>
+    <x-filament-panels::form wire:submit="save">
+        {{ $this->form }}
+
+        <x-filament-panels::form.actions
+            :actions="$this->getCachedFormActions()"
+            :full-width="$this->hasFullWidthFormActions()"
+        />
+    </x-filament-panels::form>
+
+    {{ view('cachet::filament.widgets.webhook-attempts', [
+        'attempts' => $this->record->attempts,
+    ]) }}
+</x-filament-panels::page>

resources/views/filament/widgets/webhook-attempts.blade.php

@@ -0,0 +1,24 @@
+<x-filament::section heading="{{ __('cachet::webhook.attempts.heading') }}">
+    <div class="space-y-4 text-sm">
+        @forelse($attempts as $attempt)
+            <div class="flex items-center space-x-2">
+                <div @class([
+                    'bg-red-100 text-red-500' => !$attempt->isSuccess(),
+                    'bg-primary-100 text-primary-500' => $attempt->isSuccess(),
+                    'flex-shrink-0 whitespace-nowrap px-1 py-1 rounded-md font-semibold' => true,
+                ])>
+                    @if ($attempt->isSuccess())
+                        <x-heroicon-m-check class="size-5" />
+                    @else
+                        <x-heroicon-m-x-mark class="size-5" />
+                    @endif
+                </div>
+
+                <div class="font-mono font-medium flex-1">{{ $attempt->event }}</div>
+                <div class="text-gray-500 flex-shrink-0">{{ $attempt->created_at?->toDateTimeString() }}</div>
+            </div>
+        @empty
+            <div class="text-gray-500">{{ __('cachet::webhook.attempts.empty_state') }}</div>
+        @endforelse
+    </div>
+</x-filament::section>

src/Actions/Webhook/DispatchWebhooks.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Cachet\Actions\Webhook;
+
+use Cachet\Enums\WebhookEventEnum;
+use Cachet\Models\WebhookSubscription;
+use Illuminate\Database\Eloquent\Collection;
+
+class DispatchWebhooks
+{
+    protected mixed $event;
+    protected WebhookEventEnum $eventName;
+
+    public function handle(mixed $event): void
+    {
+        $this->event = $event;
+        $this->eventName = $this->event->getWebhookEventName();
+
+        $payload = $this->event->getWebhookPayload();
+
+        foreach ($this->getWebhookSubscriptionsForEvent() as $webhookSubscription) {
+            $webhookSubscription->makeCall($this->eventName, $payload)->dispatch();
+        }
+    }
+
+    /**
+     * @return Collection<WebhookSubscription>
+     */
+    private function getWebhookSubscriptionsForEvent(): Collection
+    {
+        return WebhookSubscription::whereEvent($this->eventName)->get();
+    }
+}

src/Cachet.php

@@ -15,6 +15,11 @@ class Cachet
      */
     public const USER_AGENT = 'Cachet/3.0 (+https://docs.cachethq.io)';
 
+    /**
+     * The user agent used by Cachet's webhooks.
+     */
+    public const WEBHOOK_USER_AGENT = 'Cachet/3.0 Webhook (+https://docs.cachethq.io)';
+
     /**
      * Get the current user using `cachet.guard`.
      */

src/CachetCoreServiceProvider.php

@@ -3,6 +3,8 @@
 namespace Cachet;
 
 use BladeUI\Icons\Factory;
+use Cachet\Listeners\SendWebhookListener;
+use Cachet\Listeners\WebhookCallEventListener;
 use Cachet\Models\Incident;
 use Cachet\Models\Schedule;
 use Cachet\Settings\AppSettings;
@@ -14,10 +16,13 @@
 use Illuminate\Foundation\Console\AboutCommand;
 use Illuminate\Routing\Router;
 use Illuminate\Support\Facades\Blade;
+use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Http;
 use Illuminate\Support\Facades\RateLimiter;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
+use Spatie\WebhookServer\Events\WebhookCallFailedEvent;
+use Spatie\WebhookServer\Events\WebhookCallSucceededEvent;
 
 class CachetCoreServiceProvider extends ServiceProvider
 {
@@ -56,6 +61,9 @@ public function boot(): void
         $this->registerPublishing();
         $this->registerBladeComponents();
 
+        Event::listen('Cachet\Events\Incidents\*', SendWebhookListener::class);
+        Event::listen([WebhookCallSucceededEvent::class, WebhookCallFailedEvent::class], WebhookCallEventListener::class);
+
         Http::globalRequestMiddleware(fn ($request) => $request->withHeader(
             'User-Agent', Cachet::USER_AGENT
         ));

src/Concerns/SendsWebhook.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Cachet\Concerns;
+
+use Cachet\Enums\WebhookEventEnum;
+use Exception;
+
+trait SendsWebhook
+{
+    public function getWebhookPayload(): array
+    {
+        return [];
+    }
+
+    public function getWebhookEventName(): WebhookEventEnum
+    {
+        throw new Exception('You must implement the getWebhookEventName method on ' . static::class);
+    }
+}

src/Enums/WebhookEventEnum.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Cachet\Enums;
+
+enum WebhookEventEnum: string
+{
+    case component_created = 'component_created';
+    case component_updated = 'component_updated';
+    case component_deleted = 'component_deleted';
+    case component_status_changed = 'component_status_changed';
+
+    case incident_created = 'incident_created';
+    case incident_updated = 'incident_updated';
+    case incident_deleted = 'incident_deleted';
+
+    case metric_created = 'metric_created';
+    case metric_updated = 'metric_updated';
+    case metric_deleted = 'metric_deleted';
+    case metric_point_created = 'metric_point_created';
+    case metric_point_deleted = 'metric_point_deleted';
+
+    case subscriber_created = 'subscriber_created';
+    case subscriber_unsubscribed = 'subscriber_unsubscribed';
+    case subscriber_verified = 'subscriber_verified';
+}