Merge pull request #146 from DotNetSimon/raw_body_webhook_option

Webhook option to allow sending a raw body instead of array -> json.

Author: freekmurze

README.md

@@ -349,6 +349,19 @@ WebhookCall::create()
 ```
 or activate the `throw_exception_on_failure` global option of the `webhook-server` config file.
 
+### Sending raw string body instead of JSON
+
+By default, all webhooks will transform the payload into JSON. Instead of sending JSON, you can send any string by using the `sendRawBody(string $body)` option instead.
+
+Due to type mismatch in the Signer API, it is currently not support to sign raw data requests
+```php
+WebhookCall::create()
+    ->sendRawBody("<root>someXMLContent</root>")
+    ->doNotSign()
+    ...
+    ->dispatch();
+```
+
 ### Events
 
 The package fires these events:

src/CallWebhookJob.php

@@ -46,14 +46,16 @@ class CallWebhookJob implements ShouldQueue
     /** @var string|null */
     public $queue = null;
 
-    public array $payload = [];
+    public array|string $payload = [];
 
     public array $meta = [];
 
     public array $tags = [];
 
     public string $uuid = '';
 
+    public string $outputType = "JSON";
+
     protected ?Response $response = null;
 
     protected ?string $errorType = null;
@@ -69,7 +71,7 @@ public function handle()
         try {
             $body = strtoupper($this->httpVerb) === 'GET'
                 ? ['query' => $this->payload]
-                : ['body' => json_encode($this->payload)];
+                : ['body' => $this->generateBody()];
 
             $this->response = $this->createRequest($body);
 
@@ -162,4 +164,12 @@ private function dispatchEvent(string $eventClass)
             $this->transferStats
         ));
     }
+
+    private function generateBody(): string
+    {
+        return match ($this->outputType) {
+            "RAW" => $this->payload,
+            default => json_encode($this->payload),
+        };
+    }
 }

src/WebhookCall.php

@@ -255,6 +255,14 @@ public function dispatchSyncUnless($condition): void
         $this->dispatchSyncIf(! $condition);
     }
 
+    public function sendRawBody(string $body): self
+    {
+        $this->callWebhookJob->payload = $body;
+        $this->callWebhookJob->outputType = "RAW";
+
+        return $this;
+    }
+
     protected function prepareForDispatch(): void
     {
         if (! $this->callWebhookJob->webhookUrl) {

tests/CallWebhookJobTest.php

@@ -300,3 +300,24 @@ function baseGetRequest(array $overrides = []): array
         return true;
     });
 });
+
+it('send raw body data if rawBody is set', function () {
+    $testBody = "<xml>anotherOption</xml>";
+    WebhookCall::create()
+        ->url('https://example.com/webhooks')
+        ->useSecret('abc')
+        ->sendRawBody($testBody)
+        ->doNotSign()
+        ->dispatch();
+
+    $baseRequest = baseRequest();
+
+    $baseRequest['options']['body'] = $testBody;
+    unset($baseRequest['options']['headers']['Signature']);
+
+    artisan('queue:work --once');
+
+    $this
+        ->testClient
+        ->assertRequestsMade([$baseRequest]);
+});