Multiple Webhook Support

sethgrid · sethgrid · commit 7922352af04c · 2023-04-18T08:48:31.000-04:00
SendGrid now allows for multiple webhooks and this PR pulls in the non-breaking API changes to support it.

Webhook resources will now take an ID parameter to target specific webhooks. When a webhook resource is NOT
used with an ID, the API falls back to legacy behavior assuming there is only one webhook, and this defaults
to the oldest webhook available. Users should update their services to reference webhooks by ID.
diff --git a/examples/user/user.py b/examples/user/user.py
@@ -196,7 +196,8 @@
     "unsubscribe": True,
     "url": "url"
 }
-response = sg.client.user.webhooks.event.settings.patch(request_body=data)
+webhook_id = "some-webhook-uuid"
+response = sg.client.user.webhooks.event.settings._(webhook_id).patch(request_body=data)
 print(response.status_code)
 print(response.body)
 print(response.headers)
@@ -205,7 +206,8 @@
 # Retrieve Event Webhook settings #
 # GET /user/webhooks/event/settings #
 
-response = sg.client.user.webhooks.event.settings.get()
+webhook_id = "some-webhook-uuid"
+response = sg.client.user.webhooks.event.settings._(webhook_id).get()
 print(response.status_code)
 print(response.body)
 print(response.headers)
@@ -214,8 +216,10 @@
 # Test Event Notification Settings  #
 # POST /user/webhooks/event/test #
 
+webhook_id = "some-webhook-uuid"
 data = {
-    "url": "url"
+    "url": "url",
+    "id": webhook_id
 }
 response = sg.client.user.webhooks.event.test.post(request_body=data)
 print(response.status_code)
diff --git a/test/integ/test_sendgrid.py b/test/integ/test_sendgrid.py
@@ -1992,19 +1992,36 @@ def test_user_webhooks_event_settings_patch(self):
             "unsubscribe": True,
             "url": "url"
         }
+        webhook_id = "some-webhook-uuid"
         headers = {'X-Mock': 200}
-        response = self.sg.client.user.webhooks.event.settings.patch(
+        response = self.sg.client.user.webhooks.event.settings._(webhook_id).patch(
             request_body=data, request_headers=headers)
         self.assertEqual(response.status_code, 200)
 
-    def test_user_webhooks_event_settings_get(self):
+    # legacy webhook API only allowed for a single webhook. When no ID is provided,
+    # backwards compatiblity ensures we will get the oldest webhook back.
+    # Going forward, users should use settings._(webhook_id) in all calls.
+    def test_user_webhooks_event_settings_get_legacy_no_id(self):
         headers = {'X-Mock': 200}
+        webhook_id = "some-webhook-uuid"
         response = self.sg.client.user.webhooks.event.settings.get(
             request_headers=headers)
+        repr(response)
+        self.assertEqual(response.status_code, 200)
+
+    def test_user_webhooks_event_settings_get(self):
+        headers = {'X-Mock': 200}
+        webhook_id = "some-webhook-uuid"
+        self.assertTrue(False, "not true")
+        response = self.sg.client.user.webhooks.event.settings._(webhook_id).get(
+            request_headers=headers)
+        self.assertEqual(repr(response), "I got a response")
+
         self.assertEqual(response.status_code, 200)
 
     def test_user_webhooks_event_test_post(self):
         data = {
+            "id": "some-webhook-id",
             "url": "url"
         }
         headers = {'X-Mock': 204}
