Add event that is being fired upon the webhook's dispatch

Author: thannaske

src/Events/WebhookCallDispatchedEvent.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Spatie\WebhookServer\Events;
+
+class WebhookCallDispatchedEvent
+{
+    public function __construct(
+        public string $httpVerb,
+        public string $webhookUrl,
+        public array|string $payload,
+        public array $headers,
+        public array $meta,
+        public array $tags,
+        public string $uuid,
+    ) {
+    }
+}

src/WebhookCall.php

@@ -5,6 +5,7 @@
 use Illuminate\Foundation\Bus\PendingDispatch;
 use Illuminate\Support\Str;
 use Spatie\WebhookServer\BackoffStrategy\BackoffStrategy;
+use Spatie\WebhookServer\Events\WebhookCallDispatchedEvent;
 use Spatie\WebhookServer\Exceptions\CouldNotCallWebhook;
 use Spatie\WebhookServer\Exceptions\InvalidBackoffStrategy;
 use Spatie\WebhookServer\Exceptions\InvalidSigner;
@@ -229,6 +230,16 @@ public function dispatch(): PendingDispatch
     {
         $this->prepareForDispatch();
 
+        event(new WebhookCallDispatchedEvent(
+            $this->callWebhookJob->httpVerb,
+            $this->callWebhookJob->webhookUrl,
+            $this->callWebhookJob->payload,
+            $this->callWebhookJob->headers,
+            $this->callWebhookJob->meta,
+            $this->callWebhookJob->tags,
+            $this->callWebhookJob->uuid,
+        ));
+
         return dispatch($this->callWebhookJob);
     }
 

tests/WebhookTest.php

@@ -1,6 +1,8 @@
 <?php
 
+use Illuminate\Support\Facades\Event;
 use Illuminate\Support\Facades\Queue;
+use Spatie\WebhookServer\Events\WebhookCallDispatchedEvent;
 use function PHPUnit\Framework\assertTrue;
 use Spatie\WebhookServer\CallWebhookJob;
 use Spatie\WebhookServer\Exceptions\CouldNotCallWebhook;
@@ -155,3 +157,13 @@
 
     Queue::assertPushed(CallWebhookJob::class);
 });
+
+it('will fire an event when a webhook is initially dispatched', function () {
+    Event::fake();
+
+    $url = 'https://localhost';
+
+    WebhookCall::create()->url($url)->useSecret('123')->dispatchIf(true);
+
+    Event::assertDispatched(WebhookCallDispatchedEvent::class, 1);
+});