Merge pull request #1 from customd/webhook-based-payload-configuration

feat: webhook models can optionally modify payloads individually

src/Models/Contracts/WebhookEndpointContract.php

@@ -6,9 +6,22 @@
 
 interface WebhookEndpointContract
 {
-
      /**
       * Get the events relationship
       */
     public function events(): HasMany;
+
+    /**
+     * Get the webhook payload, customised for this specific endpoint.
+     *
+     * @return array
+     */
+    public function getWebhookPayload(WebhookEventContract $event, array $payload): array;
+
+    /**
+     * Should we allow this event to deliver webhooks?
+     *
+     * @return bool
+     */
+    public function shouldDeliverWebhook(WebhookEventContract $event, array $payload): bool;
 }

src/Models/Traits/HasWebhookEndpoint.php

@@ -9,6 +9,6 @@ trait HasWebhookEndpoint
 {
     public function endpoint(): BelongsTo
     {
-        return $this->belongsTo(WebhookEndpoint::class, 'webhook_endpoint_id');
+        return $this->belongsTo(config('webhook-registry.models.endpoint'), 'webhook_endpoint_id');
     }
 }

src/Models/Traits/HasWebhookEvent.php

@@ -2,9 +2,10 @@
 
 namespace CustomD\WebhookRegistry\Models\Traits;
 
-use CustomD\WebhookRegistry\Models\WebhookEvent;
 use Illuminate\Database\Eloquent\Builder;
+use CustomD\WebhookRegistry\Models\WebhookEvent;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use CustomD\WebhookRegistry\Models\Contracts\WebhookEventContract;
 
 trait HasWebhookEvent
 {
@@ -19,6 +20,16 @@ function ($endpoint) {
 
     public function events(): HasMany
     {
-        return $this->hasMany(WebhookEvent::class);
+        return $this->hasMany(config('webhook-registry.models.event'));
+    }
+
+    public function getWebhookPayload(WebhookEventContract $event, array $payload): array
+    {
+        return $payload;
+    }
+
+    public function shouldDeliverWebhook(WebhookEventContract $event, array $payload): bool
+    {
+        return true;
     }
 }

src/WebhookRegistry.php

@@ -144,7 +144,12 @@ public function trigger(string $event, array $payload = []): void
         }
 
         foreach ($events as $event) {
-            $this->dispatchWebhook($event->endpoint, $payload);
+
+            if (! $event->endpoint->shouldDeliverWebhook($event, $payload)) {
+                continue;
+            }
+
+            $this->dispatchWebhook($endpoint, $endpoint->getWebhookPayload($event, $payload));
         }
     }