fix: SeamWebhook: normalize headers before passing to svix + add docstrings (#113)

* Normalize headers to lowercase keys before passing to svix

* docs: Add docstrings to SeamWebhook class

* ci: Format code

* Update seam/seam_webhook.py

Co-authored-by: Evan Sosenko <evan@getseam.com>

* Update SeamWebhook dosctring and import

* Export WebhookVerificationError

* Update SeamWebhook docstrings

* Update seam/seam_webhook.py

Co-authored-by: Evan Sosenko <evan@getseam.com>

* Update seam/seam_webhook.py

Co-authored-by: Evan Sosenko <evan@getseam.com>

* Update seam/seam_webhook.py

Co-authored-by: Evan Sosenko <evan@getseam.com>

* Alias WebhookVerificationError to SeamWebhookVerificationError

* Fix typo

---------

Co-authored-by: Seam Bot <devops@getseam.com>
Co-authored-by: Evan Sosenko <evan@getseam.com>

Author: 3 people

seam/__init__.py

@@ -14,3 +14,4 @@
     SeamActionAttemptTimeoutError,
 )
 from .seam_webhook import SeamWebhook
+from svix.webhooks import WebhookVerificationError as SeamWebhookVerificationError

seam/seam_webhook.py

@@ -1,13 +1,33 @@
 from typing import Dict
-from svix import Webhook
+from svix.webhooks import Webhook
 from .routes.models import SeamEvent
 
 
 class SeamWebhook:
+    """Verifies and parses incoming Seam webhook events using the Svix library."""
+
     def __init__(self, secret: str):
+        """
+        :param secret: The secret key used for webhook verification.
+        :type secret: str
+        """
         self._webhook = Webhook(secret)
 
     def verify(self, payload: str, headers: Dict[str, str]) -> SeamEvent:
-        res = self._webhook.verify(payload, headers)
+        """Verify and parse an incoming HTTP webhook request.
+
+        Normalizes the headers, verifies the payload using the Svix
+        Webhook instance, and returns a SeamEvent object.
+
+        :param payload: The raw HTTP request body.
+        :type payload: str
+        :param headers: The HTTP request headers.
+        :type headers: Dict[str, str]
+        :return: The SeamEvent object created from the verified payload.
+        :rtype: SeamEvent
+        :raises WebhookVerificationError: If the webhook signature verification fails.
+        """
+        normalized_headers = {k.lower(): v for k, v in headers.items()}
+        res = self._webhook.verify(payload, normalized_headers)
 
         return SeamEvent.from_dict(res)