Add metadata support to Incoming Webhooks

slackapi · May 1, 2023 · a6d1a93 · a6d1a93
1 parent 8815d21
commit a6d1a93
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 0 deletions.
diff --git a/integration_tests/webhook/test_async_webhook.py b/integration_tests/webhook/test_async_webhook.py
@@ -276,3 +276,17 @@ async def test_with_attachments_dict(self):
         )
         self.assertEqual(200, response.status_code)
         self.assertEqual("ok", response.body)
+
+    @async_test
+    async def test_metadata(self):
+        url = os.environ[SLACK_SDK_TEST_INCOMING_WEBHOOK_URL]
+        webhook = AsyncWebhookClient(url)
+        response = await webhook.send(
+            text="Hello with metadata",
+            metadata={
+                "event_type": "foo",
+                "event_payload": {"foo": "bar"},
+            },
+        )
+        self.assertEqual(200, response.status_code)
+        self.assertEqual("ok", response.body)
diff --git a/integration_tests/webhook/test_webhook.py b/integration_tests/webhook/test_webhook.py
@@ -270,3 +270,16 @@ def test_with_attachments_dict(self):
         )
         self.assertEqual(200, response.status_code)
         self.assertEqual("ok", response.body)
+
+    def test_metadata(self):
+        url = os.environ[SLACK_SDK_TEST_INCOMING_WEBHOOK_URL]
+        webhook = WebhookClient(url)
+        response = webhook.send(
+            text="Hello with metadata",
+            metadata={
+                "event_type": "foo",
+                "event_payload": {"foo": "bar"},
+            },
+        )
+        self.assertEqual(200, response.status_code)
+        self.assertEqual("ok", response.body)
diff --git a/slack_sdk/webhook/async_client.py b/slack_sdk/webhook/async_client.py
@@ -96,6 +96,7 @@ async def send(
         delete_original: Optional[bool] = None,
         unfurl_links: Optional[bool] = None,
         unfurl_media: Optional[bool] = None,
+        metadata: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> WebhookResponse:
         """Performs a Slack API request and returns the result.
@@ -109,6 +110,7 @@ async def send(
             delete_original: True if you use this option for response_url requests
             unfurl_links: Option to indicate whether text url should unfurl
             unfurl_media: Option to indicate whether media url should unfurl
+            metadata: Metadata attached to the message
             headers: Request headers to append only for this request
 
         Returns:
@@ -126,6 +128,7 @@ async def send(
                 "delete_original": delete_original,
                 "unfurl_links": unfurl_links,
                 "unfurl_media": unfurl_media,
+                "metadata": metadata,
             },
             headers=headers,
         )

diff --git a/slack_sdk/webhook/client.py b/slack_sdk/webhook/client.py
@@ -86,6 +86,7 @@ def send(
         delete_original: Optional[bool] = None,
         unfurl_links: Optional[bool] = None,
         unfurl_media: Optional[bool] = None,
+        metadata: Optional[Dict[str, Any]] = None,
         headers: Optional[Dict[str, str]] = None,
     ) -> WebhookResponse:
         """Performs a Slack API request and returns the result.
@@ -100,6 +101,7 @@ def send(
             delete_original: True if you use this option for response_url requests
             unfurl_links: Option to indicate whether text url should unfurl
             unfurl_media: Option to indicate whether media url should unfurl
+            metadata: Metadata attached to the message
             headers: Request headers to append only for this request
 
         Returns:
@@ -117,6 +119,7 @@ def send(
                 "delete_original": delete_original,
                 "unfurl_links": unfurl_links,
                 "unfurl_media": unfurl_media,
+                "metadata": metadata,
             },
             headers=headers,
         )