feat: add webhook event type

Author: drish

examples/receiving_email.py

@@ -1,7 +1,6 @@
 import os
 
 import resend
-
 # Type imports
 from resend import AttachmentsReceiving, EmailsReceiving
 

examples/webhooks.py

@@ -2,14 +2,16 @@
 from typing import List
 
 import resend
+from resend.webhooks import WebhookEvent
 
 if not os.environ["RESEND_API_KEY"]:
     raise EnvironmentError("RESEND_API_KEY is missing")
 
+events: List[WebhookEvent] = ["email.sent", "email.delivered", "email.bounced"]
 
 create_params: resend.Webhooks.CreateParams = {
     "endpoint": "https://webhook.example.com/handler",
-    "events": ["email.sent", "email.delivered", "email.bounced"],
+    "events": events,
 }
 webhook: resend.Webhooks.CreateWebhookResponse = resend.Webhooks.create(
     params=create_params

resend/webhooks/__init__.py

@@ -1,4 +1,4 @@
-from resend.webhooks._webhook import Webhook
+from resend.webhooks._webhook import Webhook, WebhookEvent, WebhookStatus
 from resend.webhooks._webhooks import Webhooks
 
-__all__ = ["Webhook", "Webhooks"]
+__all__ = ["Webhook", "WebhookEvent", "WebhookStatus", "Webhooks"]

resend/webhooks/_webhook.py

@@ -4,6 +4,27 @@
 
 WebhookStatus = Literal["enabled", "disabled"]
 
+WebhookEvent = Literal[
+    # Email events
+    "email.sent",
+    "email.delivered",
+    "email.delivery_delayed",
+    "email.complained",
+    "email.bounced",
+    "email.opened",
+    "email.clicked",
+    "email.received",
+    "email.failed",
+    # Contact events
+    "contact.created",
+    "contact.updated",
+    "contact.deleted",
+    # Domain events
+    "domain.created",
+    "domain.updated",
+    "domain.deleted",
+]
+
 
 class Webhook(TypedDict):
     """
@@ -39,7 +60,7 @@ class Webhook(TypedDict):
     """
     The URL where webhook events will be sent
     """
-    events: List[str]
+    events: List[WebhookEvent]
     """
     Array of event types to subscribe to
     """

resend/webhooks/_webhooks.py

@@ -4,7 +4,7 @@
 
 from resend import request
 from resend.pagination_helper import PaginationHelper
-from resend.webhooks._webhook import Webhook, WebhookStatus
+from resend.webhooks._webhook import Webhook, WebhookEvent, WebhookStatus
 
 
 class Webhooks:
@@ -78,7 +78,7 @@ class CreateParams(TypedDict):
         """
         The URL where webhook events will be sent.
         """
-        events: List[str]
+        events: List[WebhookEvent]
         """
         Array of event types to subscribe to.
         See https://resend.com/docs/dashboard/webhooks/event-types for available options.
@@ -93,7 +93,7 @@ class UpdateParams(TypedDict):
         """
         The URL where webhook events will be sent.
         """
-        events: NotRequired[List[str]]
+        events: NotRequired[List[WebhookEvent]]
         """
         Array of event types to subscribe to.
         """
@@ -200,11 +200,8 @@ def update(cls, params: UpdateParams) -> UpdateWebhookResponse:
         webhook_id = params["webhook_id"]
         path = f"/webhooks/{webhook_id}"
 
-        # Remove webhook_id from params before sending to API
-        update_payload = {k: v for k, v in params.items() if k != "webhook_id"}
-
         resp = request.Request[Webhooks.UpdateWebhookResponse](
-            path=path, params=cast(Dict[Any, Any], update_payload), verb="patch"
+            path=path, params=cast(Dict[Any, Any], params), verb="patch"
         ).perform_with_content()
         return resp