feat(client): add support for verifying signatures on incoming webhooks

Author: stainless-app[bot]

src/openai/__init__.py

@@ -29,6 +29,7 @@
     PermissionDeniedError,
     LengthFinishReasonError,
     UnprocessableEntityError,
+    APIWebhookValidationError,
     APIResponseValidationError,
     InvalidWebhookSignatureError,
     ContentFilterFinishReasonError,
@@ -53,6 +54,7 @@
     "APITimeoutError",
     "APIConnectionError",
     "APIResponseValidationError",
+    "APIWebhookValidationError",
     "BadRequestError",
     "AuthenticationError",
     "PermissionDeniedError",

src/openai/_exceptions.py

@@ -77,6 +77,10 @@ def __init__(self, response: httpx.Response, body: object | None, *, message: st
         self.status_code = response.status_code
 
 
+class APIWebhookValidationError(APIError):
+    pass
+
+
 class APIStatusError(APIError):
     """Raised when an API response has a status code of 4xx or 5xx."""
 

tests/api_resources/test_webhooks.py

@@ -168,6 +168,13 @@ def test_verify_signature_multiple_signatures_all_invalid(self, client: openai.O
         with pytest.raises(InvalidWebhookSignatureError, match="The given webhook signature does not match"):
             client.webhooks.verify_signature(TEST_PAYLOAD, headers, secret=TEST_SECRET)
 
+    def test_method_unwrap(self, client: OpenAI) -> None:
+        data = """{"id":"id","created_at":0,"data":{"id":"id"},"type":"batch.cancelled","object":"event"}"""
+        try:
+            _ = client.webhooks.unwrap(data)
+        except Exception as e:
+            raise AssertionError("Failed to unwrap webhook") from e
+
 
 class TestAsyncWebhooks:
     parametrize = pytest.mark.parametrize(