django-webhook-subscriber 2.0.0__tar.gz → 2.1.0__tar.gz

{django_webhook_subscriber-2.0.0 → django_webhook_subscriber-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-webhook-subscriber
-Version: 2.0.0
+Version: 2.1.0
 Summary: A Django package designed to handle webhook creation, management, and delivery.
 Author-email: 42 Portugal <root@42porto.com>
 Classifier: Environment :: Web Environment
@@ -172,6 +172,53 @@ subscriber.serializer_class = "myapp.serializers.UserWebhookSerializer"
 subscriber.save()
 ```
 
+### 4. Raw Payload (No Metadata Wrapper)
+
+By default, webhook payloads include metadata and the serialized data is nested inside a `fields` key:
+
+```json
+{
+    "pk": 1,
+    "event_signal": "created",
+    "source": "auth.user",
+    "timestamp": "2026-02-05T10:30:00Z",
+    "fields": {
+        "id": 1,
+        "name": "John Doe",
+        "email": "john@example.com"
+    }
+}
+```
+
+If you prefer a raw payload containing only the serialized data (without the metadata wrapper), use the `WebhookRawPayloadMixin`:
+
+```python
+from rest_framework import serializers
+from django.contrib.auth import get_user_model
+from django_webhook_subscriber.serializers import WebhookRawPayloadMixin
+
+User = get_user_model()
+
+class UserRawWebhookSerializer(WebhookRawPayloadMixin, serializers.ModelSerializer):
+    class Meta:
+        model = User
+        fields = ["id", "name", "email"]
+
+# Update subscriber to use the raw payload serializer
+subscriber.serializer_class = "myapp.serializers.UserRawWebhookSerializer"
+subscriber.save()
+```
+
+With `WebhookRawPayloadMixin`, the webhook payload will be just the serialized data:
+
+```json
+{
+    "id": 1,
+    "name": "John Doe",
+    "email": "john@example.com"
+}
+```
+
 ## Configuration
 
 Configure the package in your Django settings:
@@ -632,6 +679,7 @@ Set up cron jobs for maintenance:
    ```
 
 3. **Monitor delivery performance:**
+
    ```bash
    # Regular performance testing
    python manage.py webhook_performance_test --model=myapp.User --event=test --object-count=10

{django_webhook_subscriber-2.0.0 → django_webhook_subscriber-2.1.0}/README.md

@@ -137,6 +137,53 @@ subscriber.serializer_class = "myapp.serializers.UserWebhookSerializer"
 subscriber.save()
 ```
 
+### 4. Raw Payload (No Metadata Wrapper)
+
+By default, webhook payloads include metadata and the serialized data is nested inside a `fields` key:
+
+```json
+{
+    "pk": 1,
+    "event_signal": "created",
+    "source": "auth.user",
+    "timestamp": "2026-02-05T10:30:00Z",
+    "fields": {
+        "id": 1,
+        "name": "John Doe",
+        "email": "john@example.com"
+    }
+}
+```
+
+If you prefer a raw payload containing only the serialized data (without the metadata wrapper), use the `WebhookRawPayloadMixin`:
+
+```python
+from rest_framework import serializers
+from django.contrib.auth import get_user_model
+from django_webhook_subscriber.serializers import WebhookRawPayloadMixin
+
+User = get_user_model()
+
+class UserRawWebhookSerializer(WebhookRawPayloadMixin, serializers.ModelSerializer):
+    class Meta:
+        model = User
+        fields = ["id", "name", "email"]
+
+# Update subscriber to use the raw payload serializer
+subscriber.serializer_class = "myapp.serializers.UserRawWebhookSerializer"
+subscriber.save()
+```
+
+With `WebhookRawPayloadMixin`, the webhook payload will be just the serialized data:
+
+```json
+{
+    "id": 1,
+    "name": "John Doe",
+    "email": "john@example.com"
+}
+```
+
 ## Configuration
 
 Configure the package in your Django settings:
@@ -597,6 +644,7 @@ Set up cron jobs for maintenance:
    ```
 
 3. **Monitor delivery performance:**
+
    ```bash
    # Regular performance testing
    python manage.py webhook_performance_test --model=myapp.User --event=test --object-count=10

{django_webhook_subscriber-2.0.0 → django_webhook_subscriber-2.1.0}/django_webhook_subscriber/delivery.py

@@ -8,7 +8,7 @@ from django.utils import timezone
 from django.utils.module_loading import import_string
 
 from .conf import rest_webhook_settings as settings
-from .serializers import serialize_webhook_instance
+from .serializers import WebhookRawPayloadMixin, serialize_webhook_instance
 from .tasks import process_webhook_delivery_batch
 from .utils import (
     clear_content_type_cache,
@@ -184,14 +184,20 @@ class WebhookDeliveryProcessor:
             )
 
             # Build standard payload structure
-            payload = {
-                "pk": instance.pk,
-                "event_signal": event_name,
-                "source": f"{instance._meta.app_label}."
-                f"{instance._meta.model_name}",
-                "timestamp": timezone.now().isoformat(),
-                "fields": fields_data,
-            }
+            if serializer_class and issubclass(
+                serializer_class, WebhookRawPayloadMixin
+            ):
+                # Raw payload mixin - use fields data directly
+                payload = fields_data
+            else:
+                payload = {
+                    "pk": instance.pk,
+                    "event_signal": event_name,
+                    "source": f"{instance._meta.app_label}."
+                    f"{instance._meta.model_name}",
+                    "timestamp": timezone.now().isoformat(),
+                    "fields": fields_data,
+                }
 
             return payload
 

{django_webhook_subscriber-2.0.0 → django_webhook_subscriber-2.1.0}/django_webhook_subscriber/serializers.py

@@ -39,3 +39,16 @@ def serialize_webhook_instance(instance, field_serializer=None):
     serialized_data = serializer.data
     # Return the serialized data
     return serialized_data
+
+
+class WebhookRawPayloadMixin:
+    """
+    Mixin to indicate that the webhook payload should be sent as raw data.
+
+    By default, the payload includes extra fields and the serialized
+    instance data goes inside a 'fields' key.
+    By having this mixin, the webhook payload will be just the
+    serialized instance data.
+    """
+
+    pass

{django_webhook_subscriber-2.0.0 → django_webhook_subscriber-2.1.0}/django_webhook_subscriber/tests/test_delivery.py

@@ -220,6 +220,78 @@ class WebhookDeliveryProcessorTests(TestCase):
         self.assertIn("error", result)
         self.assertEqual(result["fields"], {})
 
+    @patch("django_webhook_subscriber.delivery.serialize_webhook_instance")
+    @patch("django_webhook_subscriber.delivery.import_string")
+    def test_generate_payload_with_raw_payload_mixin(
+        self, mock_import_string, mock_serialize
+    ):
+        """Test that WebhookRawPayloadMixin returns only serialized data."""
+        from rest_framework import serializers
+
+        from django_webhook_subscriber.serializers import (
+            WebhookRawPayloadMixin,
+        )
+
+        # Create a serializer class with WebhookRawPayloadMixin
+        class RawPayloadSerializer(
+            WebhookRawPayloadMixin, serializers.ModelSerializer
+        ):
+            class Meta:
+                model = models.WebhookDeliveryLog
+                fields = ["id", "payload"]
+
+        mock_import_string.return_value = RawPayloadSerializer
+        mock_serialize.return_value = {"id": 1, "payload": {"key": "value"}}
+
+        result = self.processor._generate_payload(
+            self.instance,
+            "created",
+            "some.path.RawPayloadSerializer",
+        )
+
+        # With WebhookRawPayloadMixin, the payload should be the serialized
+        # data directly, without metadata wrapper
+        self.assertEqual(result, {"id": 1, "payload": {"key": "value"}})
+        self.assertNotIn("pk", result)
+        self.assertNotIn("event_signal", result)
+        self.assertNotIn("source", result)
+        self.assertNotIn("timestamp", result)
+        self.assertNotIn("fields", result)
+
+    @patch("django_webhook_subscriber.delivery.serialize_webhook_instance")
+    @patch("django_webhook_subscriber.delivery.import_string")
+    def test_generate_payload_without_raw_payload_mixin(
+        self, mock_import_string, mock_serialize
+    ):
+        """Test that regular serializers return payload with metadata."""
+        from rest_framework import serializers
+
+        # Create a regular serializer without WebhookRawPayloadMixin
+        class RegularSerializer(serializers.ModelSerializer):
+            class Meta:
+                model = models.WebhookDeliveryLog
+                fields = ["id", "payload"]
+
+        mock_import_string.return_value = RegularSerializer
+        mock_serialize.return_value = {"id": 1, "payload": {"key": "value"}}
+
+        result = self.processor._generate_payload(
+            self.instance,
+            "created",
+            "some.path.RegularSerializer",
+        )
+
+        # Without WebhookRawPayloadMixin, the payload should include metadata
+        self.assertEqual(result["pk"], 1)
+        self.assertEqual(result["event_signal"], "created")
+        self.assertEqual(
+            result["source"], "django_webhook_subscriber.webhookdeliverylog"
+        )
+        self.assertIn("timestamp", result)
+        self.assertEqual(
+            result["fields"], {"id": 1, "payload": {"key": "value"}}
+        )
+
     def test_deliver_webhooks_on_no_subscriptions(self):
         result = self.processor._deliver_webhooks([])
 

{django_webhook_subscriber-2.0.0 → django_webhook_subscriber-2.1.0}/django_webhook_subscriber.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-webhook-subscriber
-Version: 2.0.0
+Version: 2.1.0
 Summary: A Django package designed to handle webhook creation, management, and delivery.
 Author-email: 42 Portugal <root@42porto.com>
 Classifier: Environment :: Web Environment
@@ -172,6 +172,53 @@ subscriber.serializer_class = "myapp.serializers.UserWebhookSerializer"
 subscriber.save()
 ```
 
+### 4. Raw Payload (No Metadata Wrapper)
+
+By default, webhook payloads include metadata and the serialized data is nested inside a `fields` key:
+
+```json
+{
+    "pk": 1,
+    "event_signal": "created",
+    "source": "auth.user",
+    "timestamp": "2026-02-05T10:30:00Z",
+    "fields": {
+        "id": 1,
+        "name": "John Doe",
+        "email": "john@example.com"
+    }
+}
+```
+
+If you prefer a raw payload containing only the serialized data (without the metadata wrapper), use the `WebhookRawPayloadMixin`:
+
+```python
+from rest_framework import serializers
+from django.contrib.auth import get_user_model
+from django_webhook_subscriber.serializers import WebhookRawPayloadMixin
+
+User = get_user_model()
+
+class UserRawWebhookSerializer(WebhookRawPayloadMixin, serializers.ModelSerializer):
+    class Meta:
+        model = User
+        fields = ["id", "name", "email"]
+
+# Update subscriber to use the raw payload serializer
+subscriber.serializer_class = "myapp.serializers.UserRawWebhookSerializer"
+subscriber.save()
+```
+
+With `WebhookRawPayloadMixin`, the webhook payload will be just the serialized data:
+
+```json
+{
+    "id": 1,
+    "name": "John Doe",
+    "email": "john@example.com"
+}
+```
+
 ## Configuration
 
 Configure the package in your Django settings:
@@ -632,6 +679,7 @@ Set up cron jobs for maintenance:
    ```
 
 3. **Monitor delivery performance:**
+
    ```bash
    # Regular performance testing
    python manage.py webhook_performance_test --model=myapp.User --event=test --object-count=10

{django_webhook_subscriber-2.0.0 → django_webhook_subscriber-2.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "django-webhook-subscriber"
-version = "2.0.0"
+version = "2.1.0"
 dependencies = [
     "Django>=5.0,<5.3", 
     "djangorestframework>=3.15.0,<3.17",