snapshot of https://github.com/zulip/zulip.git @ 48c69911c7dd4e03b20552eb3bd77ad8151c1357 (2026-09-15)

zerver/webhooks/json/doc.md

@@ -0,0 +1,26 @@
+# Zulip JSON formatter
+
+Render JSON payloads nicely in a Zulip code block! This is
+particularly useful when you want to capture a webhook payload as part
+of [writing an incoming webhook integration][incoming-webhooks-overview].
+
+{start_tabs}
+
+1. {!create-an-incoming-webhook.md!}
+
+1. {!generate-webhook-url-basic.md!}
+
+1. Configure your application to send the webhook
+   payload to the **URL** generated above.
+
+{end_tabs}
+
+{!congrats.md!}
+
+![](/static/images/integrations/json/001.png)
+
+### Related documentation
+
+{!webhooks-url-specification.md!}
+
+[incoming-webhooks-overview]: https://zulip.readthedocs.io/en/latest/webhooks/incoming-webhooks-overview.html

zerver/webhooks/json/fixtures/json_github_push__1_commit.json

@@ -0,0 +1 @@
+../../github/fixtures/push__1_commit.json

zerver/webhooks/json/fixtures/json_pingdom_http_up_to_down.json

@@ -0,0 +1 @@
+../../pingdom/fixtures/http_up_to_down.json

zerver/webhooks/json/fixtures/json_sentry_event_for_exception_js.json

@@ -0,0 +1 @@
+../../sentry/fixtures/event_for_exception_js.json

zerver/webhooks/json/tests.py

@@ -0,0 +1,46 @@
+import json
+
+from zerver.lib.test_classes import WebhookTestCase
+
+
+class JsonHookTests(WebhookTestCase):
+    def test_json_github_push__1_commit_message(self) -> None:
+        """
+        Tests if json github push 1 commit is handled correctly
+        """
+        with open("zerver/webhooks/json/fixtures/json_github_push__1_commit.json") as f:
+            original_fixture = json.load(f)
+
+        expected_topic_name = "JSON"
+        expected_message = f"""```json
+{json.dumps(original_fixture, indent=2)}
+```"""
+        self.check_webhook("json_github_push__1_commit", expected_topic_name, expected_message)
+
+    def test_json_pingdom_http_up_to_down_message(self) -> None:
+        """
+        Tests if json pingdom http up to down is handled correctly
+        """
+        with open("zerver/webhooks/json/fixtures/json_pingdom_http_up_to_down.json") as f:
+            original_fixture = json.load(f)
+
+        expected_topic_name = "JSON"
+        expected_message = f"""```json
+{json.dumps(original_fixture, indent=2)}
+```"""
+        self.check_webhook("json_pingdom_http_up_to_down", expected_topic_name, expected_message)
+
+    def test_json_sentry_event_for_exception_js_message(self) -> None:
+        """
+        Tests if json sentry event for exception js is handled correctly
+        """
+        with open("zerver/webhooks/json/fixtures/json_sentry_event_for_exception_js.json") as f:
+            original_fixture = json.load(f)
+
+        expected_topic_name = "JSON"
+        expected_message = f"""```json
+{json.dumps(original_fixture, indent=2)}
+```"""
+        self.check_webhook(
+            "json_sentry_event_for_exception_js", expected_topic_name, expected_message
+        )

zerver/webhooks/json/view.py

@@ -0,0 +1,40 @@
+import json
+from typing import Any
+
+from django.http import HttpRequest, HttpResponse
+
+from zerver.decorator import webhook_view
+from zerver.lib.response import json_success
+from zerver.lib.typed_endpoint import JsonBodyPayload, typed_endpoint
+from zerver.lib.webhooks.common import check_send_webhook_message
+from zerver.models import UserProfile
+
+JSON_MESSAGE_TEMPLATE = """
+```json
+{webhook_payload}
+```
+""".strip()
+
+
+@webhook_view("JSON")
+@typed_endpoint
+def api_json_webhook(
+    request: HttpRequest,
+    user_profile: UserProfile,
+    *,
+    payload: JsonBodyPayload[dict[str, Any]],
+) -> HttpResponse:
+    body = get_body_for_http_request(payload)
+    topic_name = get_topic_for_http_request(payload)
+
+    check_send_webhook_message(request, user_profile, topic_name, body)
+    return json_success(request)
+
+
+def get_topic_for_http_request(payload: dict[str, Any]) -> str:
+    return "JSON"
+
+
+def get_body_for_http_request(payload: dict[str, Any]) -> str:
+    prettypayload = json.dumps(payload, indent=2)
+    return JSON_MESSAGE_TEMPLATE.format(webhook_payload=prettypayload, sort_keys=True)